models

package
v0.0.0-...-a27efb4 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// OpenapiClusterItemCloudProviderAWS captures enum value "AWS"
	OpenapiClusterItemCloudProviderAWS string = "AWS"

	// OpenapiClusterItemCloudProviderGCP captures enum value "GCP"
	OpenapiClusterItemCloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiClusterItemClusterTypeDEDICATED captures enum value "DEDICATED"
	OpenapiClusterItemClusterTypeDEDICATED string = "DEDICATED"

	// OpenapiClusterItemClusterTypeDEVELOPER captures enum value "DEVELOPER"
	OpenapiClusterItemClusterTypeDEVELOPER string = "DEVELOPER"
)
View Source 
const (

	// OpenapiClusterItemStatusClusterStatusAVAILABLE captures enum value "AVAILABLE"
	OpenapiClusterItemStatusClusterStatusAVAILABLE string = "AVAILABLE"

	// OpenapiClusterItemStatusClusterStatusCREATING captures enum value "CREATING"
	OpenapiClusterItemStatusClusterStatusCREATING string = "CREATING"

	// OpenapiClusterItemStatusClusterStatusMODIFYING captures enum value "MODIFYING"
	OpenapiClusterItemStatusClusterStatusMODIFYING string = "MODIFYING"

	// OpenapiClusterItemStatusClusterStatusPAUSED captures enum value "PAUSED"
	OpenapiClusterItemStatusClusterStatusPAUSED string = "PAUSED"

	// OpenapiClusterItemStatusClusterStatusRESUMING captures enum value "RESUMING"
	OpenapiClusterItemStatusClusterStatusRESUMING string = "RESUMING"

	// OpenapiClusterItemStatusClusterStatusUNAVAILABLE captures enum value "UNAVAILABLE"
	OpenapiClusterItemStatusClusterStatusUNAVAILABLE string = "UNAVAILABLE"

	// OpenapiClusterItemStatusClusterStatusIMPORTING captures enum value "IMPORTING"
	OpenapiClusterItemStatusClusterStatusIMPORTING string = "IMPORTING"

	// OpenapiClusterItemStatusClusterStatusMAINTAINING captures enum value "MAINTAINING"
	OpenapiClusterItemStatusClusterStatusMAINTAINING string = "MAINTAINING"

	// OpenapiClusterItemStatusClusterStatusPAUSING captures enum value "PAUSING"
	OpenapiClusterItemStatusClusterStatusPAUSING string = "PAUSING"
)
View Source 
const (

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterItemStatusClusterStatusAVAILABLE captures enum value "AVAILABLE"
	OpenapiClusterItemStatusClusterStatusAVAILABLE string = "AVAILABLE"

	// OpenapiClusterItemStatusClusterStatusCREATING captures enum value "CREATING"
	OpenapiClusterItemStatusClusterStatusCREATING string = "CREATING"

	// OpenapiClusterItemStatusClusterStatusMODIFYING captures enum value "MODIFYING"
	OpenapiClusterItemStatusClusterStatusMODIFYING string = "MODIFYING"

	// OpenapiClusterItemStatusClusterStatusPAUSED captures enum value "PAUSED"
	OpenapiClusterItemStatusClusterStatusPAUSED string = "PAUSED"

	// OpenapiClusterItemStatusClusterStatusRESUMING captures enum value "RESUMING"
	OpenapiClusterItemStatusClusterStatusRESUMING string = "RESUMING"

	// OpenapiClusterItemStatusClusterStatusUNAVAILABLE captures enum value "UNAVAILABLE"
	OpenapiClusterItemStatusClusterStatusUNAVAILABLE string = "UNAVAILABLE"

	// OpenapiClusterItemStatusClusterStatusIMPORTING captures enum value "IMPORTING"
	OpenapiClusterItemStatusClusterStatusIMPORTING string = "IMPORTING"

	// OpenapiClusterItemStatusClusterStatusMAINTAINING captures enum value "MAINTAINING"
	OpenapiClusterItemStatusClusterStatusMAINTAINING string = "MAINTAINING"

	// OpenapiClusterItemStatusClusterStatusPAUSING captures enum value "PAUSING"
	OpenapiClusterItemStatusClusterStatusPAUSING string = "PAUSING"
)
View Source 
const (

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterItemStatusNodeMapTidbItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterItemStatusNodeMapTiflashItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterItemStatusNodeMapTikvItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterNodeMapTidbItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterNodeMapTidbItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterNodeMapTidbItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterNodeMapTidbItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterNodeMapTidbItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterNodeMapTidbItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterNodeMapTiflashItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiClusterNodeMapTikvItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiClusterNodeMapTikvItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiClusterNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiClusterNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiClusterNodeMapTikvItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiClusterNodeMapTikvItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiClusterNodeMapTikvItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiClusterNodeMapTikvItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiCreatePrivateEndpointRespPrivateEndpointCloudProviderAWS captures enum value "AWS"
	OpenapiCreatePrivateEndpointRespPrivateEndpointCloudProviderAWS string = "AWS"

	// OpenapiCreatePrivateEndpointRespPrivateEndpointCloudProviderGCP captures enum value "GCP"
	OpenapiCreatePrivateEndpointRespPrivateEndpointCloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiCreatePrivateEndpointRespPrivateEndpointServiceStatusCREATING captures enum value "CREATING"
	OpenapiCreatePrivateEndpointRespPrivateEndpointServiceStatusCREATING string = "CREATING"

	// OpenapiCreatePrivateEndpointRespPrivateEndpointServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiCreatePrivateEndpointRespPrivateEndpointServiceStatusACTIVE string = "ACTIVE"

	// OpenapiCreatePrivateEndpointRespPrivateEndpointServiceStatusDELETING captures enum value "DELETING"
	OpenapiCreatePrivateEndpointRespPrivateEndpointServiceStatusDELETING string = "DELETING"
)
View Source 
const (

	// OpenapiCreatePrivateEndpointRespPrivateEndpointStatusPENDING captures enum value "PENDING"
	OpenapiCreatePrivateEndpointRespPrivateEndpointStatusPENDING string = "PENDING"

	// OpenapiCreatePrivateEndpointRespPrivateEndpointStatusACTIVE captures enum value "ACTIVE"
	OpenapiCreatePrivateEndpointRespPrivateEndpointStatusACTIVE string = "ACTIVE"

	// OpenapiCreatePrivateEndpointRespPrivateEndpointStatusDELETING captures enum value "DELETING"
	OpenapiCreatePrivateEndpointRespPrivateEndpointStatusDELETING string = "DELETING"

	// OpenapiCreatePrivateEndpointRespPrivateEndpointStatusFAILED captures enum value "FAILED"
	OpenapiCreatePrivateEndpointRespPrivateEndpointStatusFAILED string = "FAILED"
)
View Source 
const (

	// OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceCloudProviderAWS captures enum value "AWS"
	OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceCloudProviderAWS string = "AWS"

	// OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceCloudProviderGCP captures enum value "GCP"
	OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceCloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceStatusCREATING captures enum value "CREATING"
	OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceStatusCREATING string = "CREATING"

	// OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceStatusACTIVE string = "ACTIVE"

	// OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceStatusDELETING captures enum value "DELETING"
	OpenapiCreatePrivateEndpointServiceRespPrivateEndpointServiceStatusDELETING string = "DELETING"
)
View Source 
const (

	// OpenapiGetBackupOfClusterRespStatusPENDING captures enum value "PENDING"
	OpenapiGetBackupOfClusterRespStatusPENDING string = "PENDING"

	// OpenapiGetBackupOfClusterRespStatusRUNNING captures enum value "RUNNING"
	OpenapiGetBackupOfClusterRespStatusRUNNING string = "RUNNING"

	// OpenapiGetBackupOfClusterRespStatusFAILED captures enum value "FAILED"
	OpenapiGetBackupOfClusterRespStatusFAILED string = "FAILED"

	// OpenapiGetBackupOfClusterRespStatusSUCCESS captures enum value "SUCCESS"
	OpenapiGetBackupOfClusterRespStatusSUCCESS string = "SUCCESS"
)
View Source 
const (

	// OpenapiGetBackupOfClusterRespTypeMANUAL captures enum value "MANUAL"
	OpenapiGetBackupOfClusterRespTypeMANUAL string = "MANUAL"

	// OpenapiGetBackupOfClusterRespTypeAUTO captures enum value "AUTO"
	OpenapiGetBackupOfClusterRespTypeAUTO string = "AUTO"
)
View Source 
const (

	// OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceCloudProviderAWS captures enum value "AWS"
	OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceCloudProviderAWS string = "AWS"

	// OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceCloudProviderGCP captures enum value "GCP"
	OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceCloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceStatusCREATING captures enum value "CREATING"
	OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceStatusCREATING string = "CREATING"

	// OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceStatusACTIVE string = "ACTIVE"

	// OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceStatusDELETING captures enum value "DELETING"
	OpenapiGetPrivateEndpointServiceRespPrivateEndpointServiceStatusDELETING string = "DELETING"
)
View Source 
const (

	// OpenapiGetRestoreRespStatusPENDING captures enum value "PENDING"
	OpenapiGetRestoreRespStatusPENDING string = "PENDING"

	// OpenapiGetRestoreRespStatusRUNNING captures enum value "RUNNING"
	OpenapiGetRestoreRespStatusRUNNING string = "RUNNING"

	// OpenapiGetRestoreRespStatusFAILED captures enum value "FAILED"
	OpenapiGetRestoreRespStatusFAILED string = "FAILED"

	// OpenapiGetRestoreRespStatusSUCCESS captures enum value "SUCCESS"
	OpenapiGetRestoreRespStatusSUCCESS string = "SUCCESS"
)
View Source 
const (

	// OpenapiImportItemSpecSourceTypeS3 captures enum value "S3"
	OpenapiImportItemSpecSourceTypeS3 string = "S3"

	// OpenapiImportItemSpecSourceTypeGCS captures enum value "GCS"
	OpenapiImportItemSpecSourceTypeGCS string = "GCS"

	// OpenapiImportItemSpecSourceTypeLOCALFILE captures enum value "LOCAL_FILE"
	OpenapiImportItemSpecSourceTypeLOCALFILE string = "LOCAL_FILE"
)
View Source 
const (

	// OpenapiImportItemSpecSourceFormatTypeCSV captures enum value "CSV"
	OpenapiImportItemSpecSourceFormatTypeCSV string = "CSV"

	// OpenapiImportItemSpecSourceFormatTypePARQUET captures enum value "PARQUET"
	OpenapiImportItemSpecSourceFormatTypePARQUET string = "PARQUET"

	// OpenapiImportItemSpecSourceFormatTypeSQL captures enum value "SQL"
	OpenapiImportItemSpecSourceFormatTypeSQL string = "SQL"

	// OpenapiImportItemSpecSourceFormatTypeAURORASNAPSHOT captures enum value "AURORA_SNAPSHOT"
	OpenapiImportItemSpecSourceFormatTypeAURORASNAPSHOT string = "AURORA_SNAPSHOT"
)
View Source 
const (

	// OpenapiImportItemStatusPhasePREPARING captures enum value "PREPARING"
	OpenapiImportItemStatusPhasePREPARING string = "PREPARING"

	// OpenapiImportItemStatusPhaseIMPORTING captures enum value "IMPORTING"
	OpenapiImportItemStatusPhaseIMPORTING string = "IMPORTING"

	// OpenapiImportItemStatusPhaseCOMPLETED captures enum value "COMPLETED"
	OpenapiImportItemStatusPhaseCOMPLETED string = "COMPLETED"

	// OpenapiImportItemStatusPhaseFAILED captures enum value "FAILED"
	OpenapiImportItemStatusPhaseFAILED string = "FAILED"

	// OpenapiImportItemStatusPhaseCANCELING captures enum value "CANCELING"
	OpenapiImportItemStatusPhaseCANCELING string = "CANCELING"

	// OpenapiImportItemStatusPhaseCANCELED captures enum value "CANCELED"
	OpenapiImportItemStatusPhaseCANCELED string = "CANCELED"
)
View Source 
const (

	// OpenapiImportSourceTypeS3 captures enum value "S3"
	OpenapiImportSourceTypeS3 string = "S3"

	// OpenapiImportSourceTypeGCS captures enum value "GCS"
	OpenapiImportSourceTypeGCS string = "GCS"

	// OpenapiImportSourceTypeLOCALFILE captures enum value "LOCAL_FILE"
	OpenapiImportSourceTypeLOCALFILE string = "LOCAL_FILE"
)
View Source 
const (

	// OpenapiImportSourceFormatTypeCSV captures enum value "CSV"
	OpenapiImportSourceFormatTypeCSV string = "CSV"

	// OpenapiImportSourceFormatTypePARQUET captures enum value "PARQUET"
	OpenapiImportSourceFormatTypePARQUET string = "PARQUET"

	// OpenapiImportSourceFormatTypeSQL captures enum value "SQL"
	OpenapiImportSourceFormatTypeSQL string = "SQL"

	// OpenapiImportSourceFormatTypeAURORASNAPSHOT captures enum value "AURORA_SNAPSHOT"
	OpenapiImportSourceFormatTypeAURORASNAPSHOT string = "AURORA_SNAPSHOT"
)
View Source 
const (

	// OpenapiImportSourceFormatTypeCSV captures enum value "CSV"
	OpenapiImportSourceFormatTypeCSV string = "CSV"

	// OpenapiImportSourceFormatTypePARQUET captures enum value "PARQUET"
	OpenapiImportSourceFormatTypePARQUET string = "PARQUET"

	// OpenapiImportSourceFormatTypeSQL captures enum value "SQL"
	OpenapiImportSourceFormatTypeSQL string = "SQL"

	// OpenapiImportSourceFormatTypeAURORASNAPSHOT captures enum value "AURORA_SNAPSHOT"
	OpenapiImportSourceFormatTypeAURORASNAPSHOT string = "AURORA_SNAPSHOT"
)
View Source 
const (

	// OpenapiImportSpecSourceTypeS3 captures enum value "S3"
	OpenapiImportSpecSourceTypeS3 string = "S3"

	// OpenapiImportSpecSourceTypeGCS captures enum value "GCS"
	OpenapiImportSpecSourceTypeGCS string = "GCS"

	// OpenapiImportSpecSourceTypeLOCALFILE captures enum value "LOCAL_FILE"
	OpenapiImportSpecSourceTypeLOCALFILE string = "LOCAL_FILE"
)
View Source 
const (

	// OpenapiImportSpecSourceFormatTypeCSV captures enum value "CSV"
	OpenapiImportSpecSourceFormatTypeCSV string = "CSV"

	// OpenapiImportSpecSourceFormatTypePARQUET captures enum value "PARQUET"
	OpenapiImportSpecSourceFormatTypePARQUET string = "PARQUET"

	// OpenapiImportSpecSourceFormatTypeSQL captures enum value "SQL"
	OpenapiImportSpecSourceFormatTypeSQL string = "SQL"

	// OpenapiImportSpecSourceFormatTypeAURORASNAPSHOT captures enum value "AURORA_SNAPSHOT"
	OpenapiImportSpecSourceFormatTypeAURORASNAPSHOT string = "AURORA_SNAPSHOT"
)
View Source 
const (

	// OpenapiImportStatusPhasePREPARING captures enum value "PREPARING"
	OpenapiImportStatusPhasePREPARING string = "PREPARING"

	// OpenapiImportStatusPhaseIMPORTING captures enum value "IMPORTING"
	OpenapiImportStatusPhaseIMPORTING string = "IMPORTING"

	// OpenapiImportStatusPhaseCOMPLETED captures enum value "COMPLETED"
	OpenapiImportStatusPhaseCOMPLETED string = "COMPLETED"

	// OpenapiImportStatusPhaseFAILED captures enum value "FAILED"
	OpenapiImportStatusPhaseFAILED string = "FAILED"

	// OpenapiImportStatusPhaseCANCELING captures enum value "CANCELING"
	OpenapiImportStatusPhaseCANCELING string = "CANCELING"

	// OpenapiImportStatusPhaseCANCELED captures enum value "CANCELED"
	OpenapiImportStatusPhaseCANCELED string = "CANCELED"
)
View Source 
const (

	// OpenapiListBackupItemStatusPENDING captures enum value "PENDING"
	OpenapiListBackupItemStatusPENDING string = "PENDING"

	// OpenapiListBackupItemStatusRUNNING captures enum value "RUNNING"
	OpenapiListBackupItemStatusRUNNING string = "RUNNING"

	// OpenapiListBackupItemStatusFAILED captures enum value "FAILED"
	OpenapiListBackupItemStatusFAILED string = "FAILED"

	// OpenapiListBackupItemStatusSUCCESS captures enum value "SUCCESS"
	OpenapiListBackupItemStatusSUCCESS string = "SUCCESS"
)
View Source 
const (

	// OpenapiListBackupItemTypeMANUAL captures enum value "MANUAL"
	OpenapiListBackupItemTypeMANUAL string = "MANUAL"

	// OpenapiListBackupItemTypeAUTO captures enum value "AUTO"
	OpenapiListBackupItemTypeAUTO string = "AUTO"
)
View Source 
const (

	// OpenapiListBackupOfClusterRespItemsItems0StatusPENDING captures enum value "PENDING"
	OpenapiListBackupOfClusterRespItemsItems0StatusPENDING string = "PENDING"

	// OpenapiListBackupOfClusterRespItemsItems0StatusRUNNING captures enum value "RUNNING"
	OpenapiListBackupOfClusterRespItemsItems0StatusRUNNING string = "RUNNING"

	// OpenapiListBackupOfClusterRespItemsItems0StatusFAILED captures enum value "FAILED"
	OpenapiListBackupOfClusterRespItemsItems0StatusFAILED string = "FAILED"

	// OpenapiListBackupOfClusterRespItemsItems0StatusSUCCESS captures enum value "SUCCESS"
	OpenapiListBackupOfClusterRespItemsItems0StatusSUCCESS string = "SUCCESS"
)
View Source 
const (

	// OpenapiListBackupOfClusterRespItemsItems0TypeMANUAL captures enum value "MANUAL"
	OpenapiListBackupOfClusterRespItemsItems0TypeMANUAL string = "MANUAL"

	// OpenapiListBackupOfClusterRespItemsItems0TypeAUTO captures enum value "AUTO"
	OpenapiListBackupOfClusterRespItemsItems0TypeAUTO string = "AUTO"
)
View Source 
const (

	// OpenapiListClustersOfProjectRespItemsItems0CloudProviderAWS captures enum value "AWS"
	OpenapiListClustersOfProjectRespItemsItems0CloudProviderAWS string = "AWS"

	// OpenapiListClustersOfProjectRespItemsItems0CloudProviderGCP captures enum value "GCP"
	OpenapiListClustersOfProjectRespItemsItems0CloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiListClustersOfProjectRespItemsItems0ClusterTypeDEDICATED captures enum value "DEDICATED"
	OpenapiListClustersOfProjectRespItemsItems0ClusterTypeDEDICATED string = "DEDICATED"

	// OpenapiListClustersOfProjectRespItemsItems0ClusterTypeDEVELOPER captures enum value "DEVELOPER"
	OpenapiListClustersOfProjectRespItemsItems0ClusterTypeDEVELOPER string = "DEVELOPER"
)
View Source 
const (

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusAVAILABLE captures enum value "AVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusAVAILABLE string = "AVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusCREATING captures enum value "CREATING"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusCREATING string = "CREATING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusMODIFYING captures enum value "MODIFYING"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusMODIFYING string = "MODIFYING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusPAUSED captures enum value "PAUSED"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusPAUSED string = "PAUSED"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusRESUMING captures enum value "RESUMING"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusRESUMING string = "RESUMING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusUNAVAILABLE captures enum value "UNAVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusUNAVAILABLE string = "UNAVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusIMPORTING captures enum value "IMPORTING"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusIMPORTING string = "IMPORTING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusMAINTAINING captures enum value "MAINTAINING"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusMAINTAINING string = "MAINTAINING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusPAUSING captures enum value "PAUSING"
	OpenapiListClustersOfProjectRespItemsItems0StatusClusterStatusPAUSING string = "PAUSING"
)
View Source 
const (

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0StatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiListImportTasksRespItemsItems0SpecSourceTypeS3 captures enum value "S3"
	OpenapiListImportTasksRespItemsItems0SpecSourceTypeS3 string = "S3"

	// OpenapiListImportTasksRespItemsItems0SpecSourceTypeGCS captures enum value "GCS"
	OpenapiListImportTasksRespItemsItems0SpecSourceTypeGCS string = "GCS"

	// OpenapiListImportTasksRespItemsItems0SpecSourceTypeLOCALFILE captures enum value "LOCAL_FILE"
	OpenapiListImportTasksRespItemsItems0SpecSourceTypeLOCALFILE string = "LOCAL_FILE"
)
View Source 
const (

	// OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypeCSV captures enum value "CSV"
	OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypeCSV string = "CSV"

	// OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypePARQUET captures enum value "PARQUET"
	OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypePARQUET string = "PARQUET"

	// OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypeSQL captures enum value "SQL"
	OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypeSQL string = "SQL"

	// OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypeAURORASNAPSHOT captures enum value "AURORA_SNAPSHOT"
	OpenapiListImportTasksRespItemsItems0SpecSourceFormatTypeAURORASNAPSHOT string = "AURORA_SNAPSHOT"
)
View Source 
const (

	// OpenapiListImportTasksRespItemsItems0StatusPhasePREPARING captures enum value "PREPARING"
	OpenapiListImportTasksRespItemsItems0StatusPhasePREPARING string = "PREPARING"

	// OpenapiListImportTasksRespItemsItems0StatusPhaseIMPORTING captures enum value "IMPORTING"
	OpenapiListImportTasksRespItemsItems0StatusPhaseIMPORTING string = "IMPORTING"

	// OpenapiListImportTasksRespItemsItems0StatusPhaseCOMPLETED captures enum value "COMPLETED"
	OpenapiListImportTasksRespItemsItems0StatusPhaseCOMPLETED string = "COMPLETED"

	// OpenapiListImportTasksRespItemsItems0StatusPhaseFAILED captures enum value "FAILED"
	OpenapiListImportTasksRespItemsItems0StatusPhaseFAILED string = "FAILED"

	// OpenapiListImportTasksRespItemsItems0StatusPhaseCANCELING captures enum value "CANCELING"
	OpenapiListImportTasksRespItemsItems0StatusPhaseCANCELING string = "CANCELING"

	// OpenapiListImportTasksRespItemsItems0StatusPhaseCANCELED captures enum value "CANCELED"
	OpenapiListImportTasksRespItemsItems0StatusPhaseCANCELED string = "CANCELED"
)
View Source 
const (

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0CloudProviderAWS captures enum value "AWS"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0CloudProviderAWS string = "AWS"

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0CloudProviderGCP captures enum value "GCP"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0CloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0ServiceStatusCREATING captures enum value "CREATING"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0ServiceStatusCREATING string = "CREATING"

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0ServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0ServiceStatusACTIVE string = "ACTIVE"

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0ServiceStatusDELETING captures enum value "DELETING"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0ServiceStatusDELETING string = "DELETING"
)
View Source 
const (

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusPENDING captures enum value "PENDING"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusPENDING string = "PENDING"

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusACTIVE captures enum value "ACTIVE"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusACTIVE string = "ACTIVE"

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusDELETING captures enum value "DELETING"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusDELETING string = "DELETING"

	// OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusFAILED captures enum value "FAILED"
	OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0StatusFAILED string = "FAILED"
)
View Source 
const (

	// OpenapiListPrivateEndpointsRespEndpointsItems0CloudProviderAWS captures enum value "AWS"
	OpenapiListPrivateEndpointsRespEndpointsItems0CloudProviderAWS string = "AWS"

	// OpenapiListPrivateEndpointsRespEndpointsItems0CloudProviderGCP captures enum value "GCP"
	OpenapiListPrivateEndpointsRespEndpointsItems0CloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiListPrivateEndpointsRespEndpointsItems0ServiceStatusCREATING captures enum value "CREATING"
	OpenapiListPrivateEndpointsRespEndpointsItems0ServiceStatusCREATING string = "CREATING"

	// OpenapiListPrivateEndpointsRespEndpointsItems0ServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiListPrivateEndpointsRespEndpointsItems0ServiceStatusACTIVE string = "ACTIVE"

	// OpenapiListPrivateEndpointsRespEndpointsItems0ServiceStatusDELETING captures enum value "DELETING"
	OpenapiListPrivateEndpointsRespEndpointsItems0ServiceStatusDELETING string = "DELETING"
)
View Source 
const (

	// OpenapiListPrivateEndpointsRespEndpointsItems0StatusPENDING captures enum value "PENDING"
	OpenapiListPrivateEndpointsRespEndpointsItems0StatusPENDING string = "PENDING"

	// OpenapiListPrivateEndpointsRespEndpointsItems0StatusACTIVE captures enum value "ACTIVE"
	OpenapiListPrivateEndpointsRespEndpointsItems0StatusACTIVE string = "ACTIVE"

	// OpenapiListPrivateEndpointsRespEndpointsItems0StatusDELETING captures enum value "DELETING"
	OpenapiListPrivateEndpointsRespEndpointsItems0StatusDELETING string = "DELETING"

	// OpenapiListPrivateEndpointsRespEndpointsItems0StatusFAILED captures enum value "FAILED"
	OpenapiListPrivateEndpointsRespEndpointsItems0StatusFAILED string = "FAILED"
)
View Source 
const (

	// OpenapiListProviderRegionsItemCloudProviderAWS captures enum value "AWS"
	OpenapiListProviderRegionsItemCloudProviderAWS string = "AWS"

	// OpenapiListProviderRegionsItemCloudProviderGCP captures enum value "GCP"
	OpenapiListProviderRegionsItemCloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiListProviderRegionsItemClusterTypeDEDICATED captures enum value "DEDICATED"
	OpenapiListProviderRegionsItemClusterTypeDEDICATED string = "DEDICATED"

	// OpenapiListProviderRegionsItemClusterTypeDEVELOPER captures enum value "DEVELOPER"
	OpenapiListProviderRegionsItemClusterTypeDEVELOPER string = "DEVELOPER"
)
View Source 
const (

	// OpenapiListProviderRegionsRespItemsItems0CloudProviderAWS captures enum value "AWS"
	OpenapiListProviderRegionsRespItemsItems0CloudProviderAWS string = "AWS"

	// OpenapiListProviderRegionsRespItemsItems0CloudProviderGCP captures enum value "GCP"
	OpenapiListProviderRegionsRespItemsItems0CloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiListProviderRegionsRespItemsItems0ClusterTypeDEDICATED captures enum value "DEDICATED"
	OpenapiListProviderRegionsRespItemsItems0ClusterTypeDEDICATED string = "DEDICATED"

	// OpenapiListProviderRegionsRespItemsItems0ClusterTypeDEVELOPER captures enum value "DEVELOPER"
	OpenapiListProviderRegionsRespItemsItems0ClusterTypeDEVELOPER string = "DEVELOPER"
)
View Source 
const (

	// OpenapiListRestoreOfProjectRespItemsItems0StatusPENDING captures enum value "PENDING"
	OpenapiListRestoreOfProjectRespItemsItems0StatusPENDING string = "PENDING"

	// OpenapiListRestoreOfProjectRespItemsItems0StatusRUNNING captures enum value "RUNNING"
	OpenapiListRestoreOfProjectRespItemsItems0StatusRUNNING string = "RUNNING"

	// OpenapiListRestoreOfProjectRespItemsItems0StatusFAILED captures enum value "FAILED"
	OpenapiListRestoreOfProjectRespItemsItems0StatusFAILED string = "FAILED"

	// OpenapiListRestoreOfProjectRespItemsItems0StatusSUCCESS captures enum value "SUCCESS"
	OpenapiListRestoreOfProjectRespItemsItems0StatusSUCCESS string = "SUCCESS"
)
View Source 
const (

	// OpenapiListRestoreRespItemStatusPENDING captures enum value "PENDING"
	OpenapiListRestoreRespItemStatusPENDING string = "PENDING"

	// OpenapiListRestoreRespItemStatusRUNNING captures enum value "RUNNING"
	OpenapiListRestoreRespItemStatusRUNNING string = "RUNNING"

	// OpenapiListRestoreRespItemStatusFAILED captures enum value "FAILED"
	OpenapiListRestoreRespItemStatusFAILED string = "FAILED"

	// OpenapiListRestoreRespItemStatusSUCCESS captures enum value "SUCCESS"
	OpenapiListRestoreRespItemStatusSUCCESS string = "SUCCESS"
)
View Source 
const (

	// OpenapiPrivateEndpointCloudProviderAWS captures enum value "AWS"
	OpenapiPrivateEndpointCloudProviderAWS string = "AWS"

	// OpenapiPrivateEndpointCloudProviderGCP captures enum value "GCP"
	OpenapiPrivateEndpointCloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiPrivateEndpointServiceStatusCREATING captures enum value "CREATING"
	OpenapiPrivateEndpointServiceStatusCREATING string = "CREATING"

	// OpenapiPrivateEndpointServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiPrivateEndpointServiceStatusACTIVE string = "ACTIVE"

	// OpenapiPrivateEndpointServiceStatusDELETING captures enum value "DELETING"
	OpenapiPrivateEndpointServiceStatusDELETING string = "DELETING"
)
View Source 
const (

	// OpenapiPrivateEndpointStatusPENDING captures enum value "PENDING"
	OpenapiPrivateEndpointStatusPENDING string = "PENDING"

	// OpenapiPrivateEndpointStatusACTIVE captures enum value "ACTIVE"
	OpenapiPrivateEndpointStatusACTIVE string = "ACTIVE"

	// OpenapiPrivateEndpointStatusDELETING captures enum value "DELETING"
	OpenapiPrivateEndpointStatusDELETING string = "DELETING"

	// OpenapiPrivateEndpointStatusFAILED captures enum value "FAILED"
	OpenapiPrivateEndpointStatusFAILED string = "FAILED"
)
View Source 
const (

	// OpenapiPrivateEndpointServiceCloudProviderAWS captures enum value "AWS"
	OpenapiPrivateEndpointServiceCloudProviderAWS string = "AWS"

	// OpenapiPrivateEndpointServiceCloudProviderGCP captures enum value "GCP"
	OpenapiPrivateEndpointServiceCloudProviderGCP string = "GCP"
)
View Source 
const (

	// OpenapiPrivateEndpointServiceStatusCREATING captures enum value "CREATING"
	OpenapiPrivateEndpointServiceStatusCREATING string = "CREATING"

	// OpenapiPrivateEndpointServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiPrivateEndpointServiceStatusACTIVE string = "ACTIVE"

	// OpenapiPrivateEndpointServiceStatusDELETING captures enum value "DELETING"
	OpenapiPrivateEndpointServiceStatusDELETING string = "DELETING"
)
View Source 
const (

	// OpenapiTiDBNodeMapStatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiTiDBNodeMapStatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiTiDBNodeMapStatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiTiDBNodeMapStatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiTiDBNodeMapStatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiTiDBNodeMapStatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiTiDBNodeMapStatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiTiDBNodeMapStatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiTiFlashNodeMapStatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiTiFlashNodeMapStatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiTiFlashNodeMapStatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiTiFlashNodeMapStatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiTiFlashNodeMapStatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiTiFlashNodeMapStatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiTiFlashNodeMapStatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiTiFlashNodeMapStatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)
View Source 
const (

	// OpenapiTiKVNodeMapStatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiTiKVNodeMapStatusNODESTATUSAVAILABLE string = "NODE_STATUS_AVAILABLE"

	// OpenapiTiKVNodeMapStatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiTiKVNodeMapStatusNODESTATUSUNAVAILABLE string = "NODE_STATUS_UNAVAILABLE"

	// OpenapiTiKVNodeMapStatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiTiKVNodeMapStatusNODESTATUSCREATING string = "NODE_STATUS_CREATING"

	// OpenapiTiKVNodeMapStatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiTiKVNodeMapStatusNODESTATUSDELETING string = "NODE_STATUS_DELETING"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ErrorResponse 

type ErrorResponse struct {

	// code
	//
	// Error code returned with this error.
	Code int64 `json:"code,omitempty"`

	// details
	//
	// Error details returned with this error.
	Details []string `json:"details"`

	// message
	//
	// Error message returned with this error.
	Message string `json:"message,omitempty"`
}

ErrorResponse error response

swagger:model ErrorResponse

func (*ErrorResponse) ContextValidate 

func (m *ErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error response based on context it is used

func (*ErrorResponse) MarshalBinary 

func (m *ErrorResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorResponse) UnmarshalBinary 

func (m *ErrorResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorResponse) Validate 

func (m *ErrorResponse) Validate(formats strfmt.Registry) error

Validate validates this error response

type GooglerpcStatus 

type GooglerpcStatus struct {

	// code
	Code int32 `json:"code,omitempty"`

	// details
	Details []*GooglerpcStatusDetailsItems0 `json:"details"`

	// message
	Message string `json:"message,omitempty"`
}

GooglerpcStatus googlerpc status

swagger:model googlerpcStatus

func (*GooglerpcStatus) ContextValidate 

func (m *GooglerpcStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this googlerpc status based on the context it is used

func (*GooglerpcStatus) MarshalBinary 

func (m *GooglerpcStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GooglerpcStatus) UnmarshalBinary 

func (m *GooglerpcStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GooglerpcStatus) Validate 

func (m *GooglerpcStatus) Validate(formats strfmt.Registry) error

Validate validates this googlerpc status

type GooglerpcStatusDetailsItems0 

type GooglerpcStatusDetailsItems0 struct {

	// at type
	AtType string `json:"@type,omitempty"`
}

GooglerpcStatusDetailsItems0 googlerpc status details items0

swagger:model GooglerpcStatusDetailsItems0

func (*GooglerpcStatusDetailsItems0) ContextValidate 

func (m *GooglerpcStatusDetailsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this googlerpc status details items0 based on context it is used

func (*GooglerpcStatusDetailsItems0) MarshalBinary 

func (m *GooglerpcStatusDetailsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GooglerpcStatusDetailsItems0) UnmarshalBinary 

func (m *GooglerpcStatusDetailsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GooglerpcStatusDetailsItems0) Validate 

func (m *GooglerpcStatusDetailsItems0) Validate(formats strfmt.Registry) error

Validate validates this googlerpc status details items0

type ImportSourceFormatImportSourceFormatType 

type ImportSourceFormatImportSourceFormatType string

ImportSourceFormatImportSourceFormatType import source format import source format type

swagger:model ImportSourceFormatImportSourceFormatType 

const (

	// ImportSourceFormatImportSourceFormatTypeCSV captures enum value "CSV"
	ImportSourceFormatImportSourceFormatTypeCSV ImportSourceFormatImportSourceFormatType = "CSV"

	// ImportSourceFormatImportSourceFormatTypePARQUET captures enum value "PARQUET"
	ImportSourceFormatImportSourceFormatTypePARQUET ImportSourceFormatImportSourceFormatType = "PARQUET"

	// ImportSourceFormatImportSourceFormatTypeSQL captures enum value "SQL"
	ImportSourceFormatImportSourceFormatTypeSQL ImportSourceFormatImportSourceFormatType = "SQL"

	// ImportSourceFormatImportSourceFormatTypeAURORASNAPSHOT captures enum value "AURORA_SNAPSHOT"
	ImportSourceFormatImportSourceFormatTypeAURORASNAPSHOT ImportSourceFormatImportSourceFormatType = "AURORA_SNAPSHOT"
)

func NewImportSourceFormatImportSourceFormatType 

func NewImportSourceFormatImportSourceFormatType(value ImportSourceFormatImportSourceFormatType) *ImportSourceFormatImportSourceFormatType

func (ImportSourceFormatImportSourceFormatType) ContextValidate 

func (m ImportSourceFormatImportSourceFormatType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this import source format import source format type based on context it is used

func (ImportSourceFormatImportSourceFormatType) Pointer 

func (m ImportSourceFormatImportSourceFormatType) Pointer() *ImportSourceFormatImportSourceFormatType

Pointer returns a pointer to a freshly-allocated ImportSourceFormatImportSourceFormatType.

func (ImportSourceFormatImportSourceFormatType) Validate 

func (m ImportSourceFormatImportSourceFormatType) Validate(formats strfmt.Registry) error

Validate validates this import source format import source format type

type ImportSourceImportSourceType 

type ImportSourceImportSourceType string

ImportSourceImportSourceType import source import source type

swagger:model ImportSourceImportSourceType 

const (

	// ImportSourceImportSourceTypeS3 captures enum value "S3"
	ImportSourceImportSourceTypeS3 ImportSourceImportSourceType = "S3"

	// ImportSourceImportSourceTypeGCS captures enum value "GCS"
	ImportSourceImportSourceTypeGCS ImportSourceImportSourceType = "GCS"

	// ImportSourceImportSourceTypeLOCALFILE captures enum value "LOCAL_FILE"
	ImportSourceImportSourceTypeLOCALFILE ImportSourceImportSourceType = "LOCAL_FILE"
)

func NewImportSourceImportSourceType 

func NewImportSourceImportSourceType(value ImportSourceImportSourceType) *ImportSourceImportSourceType

func (ImportSourceImportSourceType) ContextValidate 

func (m ImportSourceImportSourceType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this import source import source type based on context it is used

func (ImportSourceImportSourceType) Pointer 

func (m ImportSourceImportSourceType) Pointer() *ImportSourceImportSourceType

Pointer returns a pointer to a freshly-allocated ImportSourceImportSourceType.

func (ImportSourceImportSourceType) Validate 

func (m ImportSourceImportSourceType) Validate(formats strfmt.Registry) error

Validate validates this import source import source type

type ImportStatusImportTaskPhase 

type ImportStatusImportTaskPhase string

ImportStatusImportTaskPhase import status import task phase

swagger:model ImportStatusImportTaskPhase 

const (

	// ImportStatusImportTaskPhasePREPARING captures enum value "PREPARING"
	ImportStatusImportTaskPhasePREPARING ImportStatusImportTaskPhase = "PREPARING"

	// ImportStatusImportTaskPhaseIMPORTING captures enum value "IMPORTING"
	ImportStatusImportTaskPhaseIMPORTING ImportStatusImportTaskPhase = "IMPORTING"

	// ImportStatusImportTaskPhaseCOMPLETED captures enum value "COMPLETED"
	ImportStatusImportTaskPhaseCOMPLETED ImportStatusImportTaskPhase = "COMPLETED"

	// ImportStatusImportTaskPhaseFAILED captures enum value "FAILED"
	ImportStatusImportTaskPhaseFAILED ImportStatusImportTaskPhase = "FAILED"

	// ImportStatusImportTaskPhaseCANCELING captures enum value "CANCELING"
	ImportStatusImportTaskPhaseCANCELING ImportStatusImportTaskPhase = "CANCELING"

	// ImportStatusImportTaskPhaseCANCELED captures enum value "CANCELED"
	ImportStatusImportTaskPhaseCANCELED ImportStatusImportTaskPhase = "CANCELED"
)

func NewImportStatusImportTaskPhase 

func NewImportStatusImportTaskPhase(value ImportStatusImportTaskPhase) *ImportStatusImportTaskPhase

func (ImportStatusImportTaskPhase) ContextValidate 

func (m ImportStatusImportTaskPhase) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this import status import task phase based on context it is used

func (ImportStatusImportTaskPhase) Pointer 

func (m ImportStatusImportTaskPhase) Pointer() *ImportStatusImportTaskPhase

Pointer returns a pointer to a freshly-allocated ImportStatusImportTaskPhase.

func (ImportStatusImportTaskPhase) Validate 

func (m ImportStatusImportTaskPhase) Validate(formats strfmt.Registry) error

Validate validates this import status import task phase

type OpenapiAwsAssumeRoleAccess 

type OpenapiAwsAssumeRoleAccess struct {

	// The specific AWS role ARN that needs to be assumed to access the Amazon S3 data source.
	// Example: arn:aws:iam::999999999999:role/sample-role
	// Required: true
	AssumeRole *string `json:"assume_role"`
}

OpenapiAwsAssumeRoleAccess AwsAssumeRoleAccess

AwsAssumeRoleAccess represents the settings to access the Amazon S3 source by assuming to a specific AWS role.

swagger:model openapiAwsAssumeRoleAccess

func (*OpenapiAwsAssumeRoleAccess) ContextValidate 

func (m *OpenapiAwsAssumeRoleAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi aws assume role access based on context it is used

func (*OpenapiAwsAssumeRoleAccess) MarshalBinary 

func (m *OpenapiAwsAssumeRoleAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiAwsAssumeRoleAccess) UnmarshalBinary 

func (m *OpenapiAwsAssumeRoleAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiAwsAssumeRoleAccess) Validate 

func (m *OpenapiAwsAssumeRoleAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi aws assume role access

type OpenapiAwsCmekSpec 

type OpenapiAwsCmekSpec struct {

	// The KMS ARN of the AWS CMEK.
	// Example: arn:aws:kms:example
	// Required: true
	KmsArn *string `json:"kms_arn"`

	// The region name of the AWS CMEK. The region value should match the cloud provider's region code.
	//
	// You can get the complete list of available regions from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// For the detailed information on each region, refer to the documentation of the [AWS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) cloud provider.
	// Example: us-west-2
	// Required: true
	Region *string `json:"region"`
}

OpenapiAwsCmekSpec AwsCmekSpec

AwsCmekSpec is the specification of the AWS CMEK.

swagger:model openapiAwsCmekSpec

func (*OpenapiAwsCmekSpec) ContextValidate 

func (m *OpenapiAwsCmekSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi aws cmek spec based on context it is used

func (*OpenapiAwsCmekSpec) MarshalBinary 

func (m *OpenapiAwsCmekSpec) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiAwsCmekSpec) UnmarshalBinary 

func (m *OpenapiAwsCmekSpec) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiAwsCmekSpec) Validate 

func (m *OpenapiAwsCmekSpec) Validate(formats strfmt.Registry) error

Validate validates this openapi aws cmek spec

type OpenapiAwsImportTaskRoleInfo 

type OpenapiAwsImportTaskRoleInfo struct {

	// The account ID under which the import tasks for this cluster are running.
	// Example: 999999999999
	// Required: true
	AccountID *string `json:"account_id"`

	// The unique external ID that binds to the cluster, which is a long string. When an import task starts and attempts to assume a specified role, it automatically attaches this external ID. This means that you can configure this external ID in the assumed role's trust relationship, so that only the import task of that specified cluster can access the data by assuming the role. This can provide additional security.
	// Example: abcdefghijklmnopqrstuvwxyz0123456789xxxxxxxxxxxxxx
	// Required: true
	ExternalID *string `json:"external_id"`
}

OpenapiAwsImportTaskRoleInfo AwsImportTaskRoleInfo

AwsImportTaskRoleInfo is the role information for import tasks on an AWS cluster.

swagger:model openapiAwsImportTaskRoleInfo

func (*OpenapiAwsImportTaskRoleInfo) ContextValidate 

func (m *OpenapiAwsImportTaskRoleInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi aws import task role info based on context it is used

func (*OpenapiAwsImportTaskRoleInfo) MarshalBinary 

func (m *OpenapiAwsImportTaskRoleInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiAwsImportTaskRoleInfo) UnmarshalBinary 

func (m *OpenapiAwsImportTaskRoleInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiAwsImportTaskRoleInfo) Validate 

func (m *OpenapiAwsImportTaskRoleInfo) Validate(formats strfmt.Registry) error

Validate validates this openapi aws import task role info

type OpenapiAwsKeyAccess 

type OpenapiAwsKeyAccess struct {

	// The access key ID of the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_ACCESS_KEY_ID
	// Required: true
	AccessKeyID *string `json:"access_key_id"`

	// The secret access key for the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_SECRET_ACCESS_KEY
	// Required: true
	SecretAccessKey *string `json:"secret_access_key"`
}

OpenapiAwsKeyAccess AwsKeyAccess

AwsKeyAccess represents the settings to access the Amazon S3 source by using access keys.

swagger:model openapiAwsKeyAccess

func (*OpenapiAwsKeyAccess) ContextValidate 

func (m *OpenapiAwsKeyAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi aws key access based on context it is used

func (*OpenapiAwsKeyAccess) MarshalBinary 

func (m *OpenapiAwsKeyAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiAwsKeyAccess) UnmarshalBinary 

func (m *OpenapiAwsKeyAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiAwsKeyAccess) Validate 

func (m *OpenapiAwsKeyAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi aws key access

type OpenapiBackupTypeEnum 

type OpenapiBackupTypeEnum string

OpenapiBackupTypeEnum openapi backup type enum

swagger:model openapiBackupTypeEnum 

const (

	// OpenapiBackupTypeEnumMANUAL captures enum value "MANUAL"
	OpenapiBackupTypeEnumMANUAL OpenapiBackupTypeEnum = "MANUAL"

	// OpenapiBackupTypeEnumAUTO captures enum value "AUTO"
	OpenapiBackupTypeEnumAUTO OpenapiBackupTypeEnum = "AUTO"
)

func NewOpenapiBackupTypeEnum 

func NewOpenapiBackupTypeEnum(value OpenapiBackupTypeEnum) *OpenapiBackupTypeEnum

func (OpenapiBackupTypeEnum) ContextValidate 

func (m OpenapiBackupTypeEnum) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi backup type enum based on context it is used

func (OpenapiBackupTypeEnum) Pointer 

func (m OpenapiBackupTypeEnum) Pointer() *OpenapiBackupTypeEnum

Pointer returns a pointer to a freshly-allocated OpenapiBackupTypeEnum.

func (OpenapiBackupTypeEnum) Validate 

func (m OpenapiBackupTypeEnum) Validate(formats strfmt.Registry) error

Validate validates this openapi backup type enum

type OpenapiCloudProvider 

type OpenapiCloudProvider string

OpenapiCloudProvider openapi cloud provider

swagger:model openapiCloudProvider 

const (

	// OpenapiCloudProviderAWS captures enum value "AWS"
	OpenapiCloudProviderAWS OpenapiCloudProvider = "AWS"

	// OpenapiCloudProviderGCP captures enum value "GCP"
	OpenapiCloudProviderGCP OpenapiCloudProvider = "GCP"
)

func NewOpenapiCloudProvider 

func NewOpenapiCloudProvider(value OpenapiCloudProvider) *OpenapiCloudProvider

func (OpenapiCloudProvider) ContextValidate 

func (m OpenapiCloudProvider) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cloud provider based on context it is used

func (OpenapiCloudProvider) Pointer 

func (m OpenapiCloudProvider) Pointer() *OpenapiCloudProvider

Pointer returns a pointer to a freshly-allocated OpenapiCloudProvider.

func (OpenapiCloudProvider) Validate 

func (m OpenapiCloudProvider) Validate(formats strfmt.Registry) error

Validate validates this openapi cloud provider

type OpenapiClusterComponents 

type OpenapiClusterComponents struct {

	// tidb
	// Required: true
	Tidb *OpenapiClusterComponentsTidb `json:"tidb"`

	// tiflash
	Tiflash *OpenapiClusterComponentsTiflash `json:"tiflash,omitempty"`

	// tikv
	// Required: true
	Tikv *OpenapiClusterComponentsTikv `json:"tikv"`
}

OpenapiClusterComponents openapi cluster components

swagger:model openapiClusterComponents

func (*OpenapiClusterComponents) ContextValidate 

func (m *OpenapiClusterComponents) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster components based on the context it is used

func (*OpenapiClusterComponents) MarshalBinary 

func (m *OpenapiClusterComponents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterComponents) UnmarshalBinary 

func (m *OpenapiClusterComponents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterComponents) Validate 

func (m *OpenapiClusterComponents) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster components

type OpenapiClusterComponentsTidb 

type OpenapiClusterComponentsTidb struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 2
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C16G
	// Required: true
	NodeSize *string `json:"node_size"`
}

OpenapiClusterComponentsTidb The TiDB component of the cluster.

swagger:model OpenapiClusterComponentsTidb

func (*OpenapiClusterComponentsTidb) ContextValidate 

func (m *OpenapiClusterComponentsTidb) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster components tidb based on context it is used

func (*OpenapiClusterComponentsTidb) MarshalBinary 

func (m *OpenapiClusterComponentsTidb) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterComponentsTidb) UnmarshalBinary 

func (m *OpenapiClusterComponentsTidb) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterComponentsTidb) Validate 

func (m *OpenapiClusterComponentsTidb) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster components tidb

type OpenapiClusterComponentsTiflash 

type OpenapiClusterComponentsTiflash struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiClusterComponentsTiflash The TiFlash component of the cluster.

swagger:model OpenapiClusterComponentsTiflash

func (*OpenapiClusterComponentsTiflash) ContextValidate 

func (m *OpenapiClusterComponentsTiflash) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster components tiflash based on context it is used

func (*OpenapiClusterComponentsTiflash) MarshalBinary 

func (m *OpenapiClusterComponentsTiflash) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterComponentsTiflash) UnmarshalBinary 

func (m *OpenapiClusterComponentsTiflash) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterComponentsTiflash) Validate 

func (m *OpenapiClusterComponentsTiflash) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster components tiflash

type OpenapiClusterComponentsTikv 

type OpenapiClusterComponentsTikv struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 3
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiClusterComponentsTikv The TiKV component of the cluster.

swagger:model OpenapiClusterComponentsTikv

func (*OpenapiClusterComponentsTikv) ContextValidate 

func (m *OpenapiClusterComponentsTikv) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster components tikv based on context it is used

func (*OpenapiClusterComponentsTikv) MarshalBinary 

func (m *OpenapiClusterComponentsTikv) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterComponentsTikv) UnmarshalBinary 

func (m *OpenapiClusterComponentsTikv) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterComponentsTikv) Validate 

func (m *OpenapiClusterComponentsTikv) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster components tikv

type OpenapiClusterConfig 

type OpenapiClusterConfig struct {

	// components
	Components *OpenapiClusterConfigComponents `json:"components,omitempty"`

	// A list of IP addresses and Classless Inter-Domain Routing (CIDR) addresses that are allowed to access the TiDB Cloud cluster via [standard connection](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster#connect-via-standard-connection).
	IPAccessList []*OpenapiClusterConfigIPAccessListItems0 `json:"ip_access_list"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`

	// The root password to access the cluster. It must be 8-64 characters.
	// Example: password_example
	// Required: true
	// Max Length: 64
	// Min Length: 8
	RootPassword *string `json:"root_password"`
}

OpenapiClusterConfig openapi cluster config

swagger:model openapiClusterConfig

func (*OpenapiClusterConfig) ContextValidate 

func (m *OpenapiClusterConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster config based on the context it is used

func (*OpenapiClusterConfig) MarshalBinary 

func (m *OpenapiClusterConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConfig) UnmarshalBinary 

func (m *OpenapiClusterConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConfig) Validate 

func (m *OpenapiClusterConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster config

type OpenapiClusterConfigComponents 

type OpenapiClusterConfigComponents struct {

	// tidb
	// Required: true
	Tidb *OpenapiClusterConfigComponentsTidb `json:"tidb"`

	// tiflash
	Tiflash *OpenapiClusterConfigComponentsTiflash `json:"tiflash,omitempty"`

	// tikv
	// Required: true
	Tikv *OpenapiClusterConfigComponentsTikv `json:"tikv"`
}

OpenapiClusterConfigComponents The components of the cluster.

**Limitations**: - For a TiDB Dedicated cluster, the `components` parameter is **required**. - For a TiDB Serverless cluster, the `components` value is **ignored**. Setting this configuration does not have any effects. Example: {"tidb":{"node_quantity":2,"node_size":"8C16G"},"tikv":{"node_quantity":3,"node_size":"8C32G","storage_size_gib":1024}}

swagger:model OpenapiClusterConfigComponents

func (*OpenapiClusterConfigComponents) ContextValidate 

func (m *OpenapiClusterConfigComponents) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster config components based on the context it is used

func (*OpenapiClusterConfigComponents) MarshalBinary 

func (m *OpenapiClusterConfigComponents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConfigComponents) UnmarshalBinary 

func (m *OpenapiClusterConfigComponents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConfigComponents) Validate 

func (m *OpenapiClusterConfigComponents) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster config components

type OpenapiClusterConfigComponentsTidb 

type OpenapiClusterConfigComponentsTidb struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 2
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C16G
	// Required: true
	NodeSize *string `json:"node_size"`
}

OpenapiClusterConfigComponentsTidb The TiDB component of the cluster.

swagger:model OpenapiClusterConfigComponentsTidb

func (*OpenapiClusterConfigComponentsTidb) ContextValidate 

func (m *OpenapiClusterConfigComponentsTidb) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster config components tidb based on context it is used

func (*OpenapiClusterConfigComponentsTidb) MarshalBinary 

func (m *OpenapiClusterConfigComponentsTidb) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConfigComponentsTidb) UnmarshalBinary 

func (m *OpenapiClusterConfigComponentsTidb) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConfigComponentsTidb) Validate 

func (m *OpenapiClusterConfigComponentsTidb) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster config components tidb

type OpenapiClusterConfigComponentsTiflash 

type OpenapiClusterConfigComponentsTiflash struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiClusterConfigComponentsTiflash The TiFlash component of the cluster.

swagger:model OpenapiClusterConfigComponentsTiflash

func (*OpenapiClusterConfigComponentsTiflash) ContextValidate 

func (m *OpenapiClusterConfigComponentsTiflash) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster config components tiflash based on context it is used

func (*OpenapiClusterConfigComponentsTiflash) MarshalBinary 

func (m *OpenapiClusterConfigComponentsTiflash) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConfigComponentsTiflash) UnmarshalBinary 

func (m *OpenapiClusterConfigComponentsTiflash) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConfigComponentsTiflash) Validate 

func (m *OpenapiClusterConfigComponentsTiflash) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster config components tiflash

type OpenapiClusterConfigComponentsTikv 

type OpenapiClusterConfigComponentsTikv struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 3
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiClusterConfigComponentsTikv The TiKV component of the cluster.

swagger:model OpenapiClusterConfigComponentsTikv

func (*OpenapiClusterConfigComponentsTikv) ContextValidate 

func (m *OpenapiClusterConfigComponentsTikv) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster config components tikv based on context it is used

func (*OpenapiClusterConfigComponentsTikv) MarshalBinary 

func (m *OpenapiClusterConfigComponentsTikv) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConfigComponentsTikv) UnmarshalBinary 

func (m *OpenapiClusterConfigComponentsTikv) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConfigComponentsTikv) Validate 

func (m *OpenapiClusterConfigComponentsTikv) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster config components tikv

type OpenapiClusterConfigIPAccessListItems0 

type OpenapiClusterConfigIPAccessListItems0 struct {

	// The IP address or CIDR range that you want to add to the cluster's IP access list.
	// Example: 8.8.8.8/32
	// Required: true
	Cidr *string `json:"cidr"`

	// Description that explains the purpose of the entry.
	// Example: My Current IP Address
	Description string `json:"description,omitempty"`
}

OpenapiClusterConfigIPAccessListItems0 openapi cluster config IP access list items0

swagger:model OpenapiClusterConfigIPAccessListItems0

func (*OpenapiClusterConfigIPAccessListItems0) ContextValidate 

func (m *OpenapiClusterConfigIPAccessListItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster config IP access list items0 based on context it is used

func (*OpenapiClusterConfigIPAccessListItems0) MarshalBinary 

func (m *OpenapiClusterConfigIPAccessListItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConfigIPAccessListItems0) UnmarshalBinary 

func (m *OpenapiClusterConfigIPAccessListItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConfigIPAccessListItems0) Validate 

func (m *OpenapiClusterConfigIPAccessListItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster config IP access list items0

type OpenapiClusterConnectionStrings 

type OpenapiClusterConnectionStrings struct {

	// The default TiDB user for connection.
	// Example: root
	DefaultUser string `json:"default_user,omitempty"`

	// standard
	Standard *OpenapiClusterConnectionStringsStandard `json:"standard,omitempty"`

	// vpc peering
	VpcPeering *OpenapiClusterConnectionStringsVpcPeering `json:"vpc_peering,omitempty"`
}

OpenapiClusterConnectionStrings openapi cluster connection strings

swagger:model openapiClusterConnectionStrings

func (*OpenapiClusterConnectionStrings) ContextValidate 

func (m *OpenapiClusterConnectionStrings) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster connection strings based on the context it is used

func (*OpenapiClusterConnectionStrings) MarshalBinary 

func (m *OpenapiClusterConnectionStrings) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConnectionStrings) UnmarshalBinary 

func (m *OpenapiClusterConnectionStrings) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConnectionStrings) Validate 

func (m *OpenapiClusterConnectionStrings) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster connection strings

type OpenapiClusterConnectionStringsStandard 

type OpenapiClusterConnectionStringsStandard struct {

	// The host of standard connection.
	// Example: tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiClusterConnectionStringsStandard Standard connection string.

You must configure the [IP Access List](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster#connect-via-standard-connection) for the cluster you created on [TiDB Cloud console](https://tidbcloud.com/) before connecting to this connection string.

swagger:model OpenapiClusterConnectionStringsStandard

func (*OpenapiClusterConnectionStringsStandard) ContextValidate 

func (m *OpenapiClusterConnectionStringsStandard) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster connection strings standard based on context it is used

func (*OpenapiClusterConnectionStringsStandard) MarshalBinary 

func (m *OpenapiClusterConnectionStringsStandard) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConnectionStringsStandard) UnmarshalBinary 

func (m *OpenapiClusterConnectionStringsStandard) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConnectionStringsStandard) Validate 

func (m *OpenapiClusterConnectionStringsStandard) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster connection strings standard

type OpenapiClusterConnectionStringsVpcPeering 

type OpenapiClusterConnectionStringsVpcPeering struct {

	// The host of VPC peering connection.
	// Example: private-tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiClusterConnectionStringsVpcPeering [VPC peering](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary#vpc-peering) connection string.

You must [Set up VPC peering connections](https://docs.pingcap.com/tidbcloud/set-up-vpc-peering-connections) for the project before connecting to this private connection string.

swagger:model OpenapiClusterConnectionStringsVpcPeering

func (*OpenapiClusterConnectionStringsVpcPeering) ContextValidate 

func (m *OpenapiClusterConnectionStringsVpcPeering) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster connection strings vpc peering based on context it is used

func (*OpenapiClusterConnectionStringsVpcPeering) MarshalBinary 

func (m *OpenapiClusterConnectionStringsVpcPeering) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterConnectionStringsVpcPeering) UnmarshalBinary 

func (m *OpenapiClusterConnectionStringsVpcPeering) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterConnectionStringsVpcPeering) Validate 

func (m *OpenapiClusterConnectionStringsVpcPeering) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster connection strings vpc peering

type OpenapiClusterInfoOfRestore 

type OpenapiClusterInfoOfRestore struct {

	// The ID of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: cluster-1
	Name string `json:"name,omitempty"`

	// The status of the restored cluster. Possible values are `"AVAILABLE"`, `"CREATING"`, `"MODIFYING"`, `"PAUSED"`, `"RESUMING"`, `"UNAVAILABLE"`, `"IMPORTING"`, and `"CLEARED"`.
	// Example: AVAILABLE
	Status string `json:"status,omitempty"`
}

OpenapiClusterInfoOfRestore ClusterInfoOfRestore

The information of the restored cluster. The restored cluster is the new cluster your backup data is restored to.

swagger:model openapiClusterInfoOfRestore

func (*OpenapiClusterInfoOfRestore) ContextValidate 

func (m *OpenapiClusterInfoOfRestore) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster info of restore based on context it is used

func (*OpenapiClusterInfoOfRestore) MarshalBinary 

func (m *OpenapiClusterInfoOfRestore) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterInfoOfRestore) UnmarshalBinary 

func (m *OpenapiClusterInfoOfRestore) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterInfoOfRestore) Validate 

func (m *OpenapiClusterInfoOfRestore) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster info of restore

type OpenapiClusterItem 

type OpenapiClusterItem struct {

	// The cloud provider on which your TiDB cluster is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// The cluster type:
	// - `"DEVELOPER"`: a [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) cluster
	// - `"DEDICATED"`: a [TiDB Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#dedicated-tier) cluster
	//
	// **Warning:** `"DEVELOPER"` will soon be changed to `"SERVERLESS"` to represent TiDB Serverless clusters.
	// Example: DEDICATED
	// Enum: [DEDICATED DEVELOPER]
	ClusterType string `json:"cluster_type,omitempty"`

	// config
	Config *OpenapiClusterItemConfig `json:"config,omitempty"`

	// The creation time of the cluster in Unix timestamp seconds (epoch time).
	// Example: 1656991448
	CreateTimestamp string `json:"create_timestamp,omitempty"`

	// The ID of the cluster.
	// Example: 1
	// Required: true
	ID *string `json:"id"`

	// The name of the cluster.
	// Example: Cluster0
	// Pattern: ^[A-Za-z0-9][-A-Za-z0-9]{2,62}[A-Za-z0-9]$
	Name string `json:"name,omitempty"`

	// The ID of the project.
	// Example: 1
	// Required: true
	ProjectID *string `json:"project_id"`

	// Region of the cluster.
	// Example: us-west-2
	Region string `json:"region,omitempty"`

	// status
	Status *OpenapiClusterItemStatus `json:"status,omitempty"`
}

OpenapiClusterItem ClusterItem

ClusterItem is the information of cluster.

swagger:model openapiClusterItem

func (*OpenapiClusterItem) ContextValidate 

func (m *OpenapiClusterItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster item based on the context it is used

func (*OpenapiClusterItem) MarshalBinary 

func (m *OpenapiClusterItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItem) UnmarshalBinary 

func (m *OpenapiClusterItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItem) Validate 

func (m *OpenapiClusterItem) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item

type OpenapiClusterItemConfig 

type OpenapiClusterItemConfig struct {

	// components
	Components *OpenapiClusterItemConfigComponents `json:"components,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiClusterItemConfig The configuration of the cluster. Example: {"components":{"tidb":{"node_quantity":2,"node_size":"8C16G"},"tikv":{"node_quantity":3,"node_size":"8C32G","storage_size_gib":1024}},"port":4000}

swagger:model OpenapiClusterItemConfig

func (*OpenapiClusterItemConfig) ContextValidate 

func (m *OpenapiClusterItemConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster item config based on the context it is used

func (*OpenapiClusterItemConfig) MarshalBinary 

func (m *OpenapiClusterItemConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemConfig) UnmarshalBinary 

func (m *OpenapiClusterItemConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemConfig) Validate 

func (m *OpenapiClusterItemConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item config

type OpenapiClusterItemConfigComponents 

type OpenapiClusterItemConfigComponents struct {

	// tidb
	// Required: true
	Tidb *OpenapiClusterItemConfigComponentsTidb `json:"tidb"`

	// tiflash
	Tiflash *OpenapiClusterItemConfigComponentsTiflash `json:"tiflash,omitempty"`

	// tikv
	// Required: true
	Tikv *OpenapiClusterItemConfigComponentsTikv `json:"tikv"`
}

OpenapiClusterItemConfigComponents The components of the cluster. Example: {"tidb":{"node_quantity":2,"node_size":"8C16G"},"tikv":{"node_quantity":3,"node_size":"8C32G","storage_size_gib":1024}}

swagger:model OpenapiClusterItemConfigComponents

func (*OpenapiClusterItemConfigComponents) ContextValidate 

func (m *OpenapiClusterItemConfigComponents) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster item config components based on the context it is used

func (*OpenapiClusterItemConfigComponents) MarshalBinary 

func (m *OpenapiClusterItemConfigComponents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponents) UnmarshalBinary 

func (m *OpenapiClusterItemConfigComponents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponents) Validate 

func (m *OpenapiClusterItemConfigComponents) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item config components

type OpenapiClusterItemConfigComponentsTidb 

type OpenapiClusterItemConfigComponentsTidb struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 2
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C16G
	// Required: true
	NodeSize *string `json:"node_size"`
}

OpenapiClusterItemConfigComponentsTidb The TiDB component of the cluster.

swagger:model OpenapiClusterItemConfigComponentsTidb

func (*OpenapiClusterItemConfigComponentsTidb) ContextValidate 

func (m *OpenapiClusterItemConfigComponentsTidb) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item config components tidb based on context it is used

func (*OpenapiClusterItemConfigComponentsTidb) MarshalBinary 

func (m *OpenapiClusterItemConfigComponentsTidb) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponentsTidb) UnmarshalBinary 

func (m *OpenapiClusterItemConfigComponentsTidb) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponentsTidb) Validate 

func (m *OpenapiClusterItemConfigComponentsTidb) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item config components tidb

type OpenapiClusterItemConfigComponentsTiflash 

type OpenapiClusterItemConfigComponentsTiflash struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiClusterItemConfigComponentsTiflash The TiFlash component of the cluster.

swagger:model OpenapiClusterItemConfigComponentsTiflash

func (*OpenapiClusterItemConfigComponentsTiflash) ContextValidate 

func (m *OpenapiClusterItemConfigComponentsTiflash) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item config components tiflash based on context it is used

func (*OpenapiClusterItemConfigComponentsTiflash) MarshalBinary 

func (m *OpenapiClusterItemConfigComponentsTiflash) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponentsTiflash) UnmarshalBinary 

func (m *OpenapiClusterItemConfigComponentsTiflash) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponentsTiflash) Validate 

func (m *OpenapiClusterItemConfigComponentsTiflash) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item config components tiflash

type OpenapiClusterItemConfigComponentsTikv 

type OpenapiClusterItemConfigComponentsTikv struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 3
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiClusterItemConfigComponentsTikv The TiKV component of the cluster.

swagger:model OpenapiClusterItemConfigComponentsTikv

func (*OpenapiClusterItemConfigComponentsTikv) ContextValidate 

func (m *OpenapiClusterItemConfigComponentsTikv) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item config components tikv based on context it is used

func (*OpenapiClusterItemConfigComponentsTikv) MarshalBinary 

func (m *OpenapiClusterItemConfigComponentsTikv) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponentsTikv) UnmarshalBinary 

func (m *OpenapiClusterItemConfigComponentsTikv) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemConfigComponentsTikv) Validate 

func (m *OpenapiClusterItemConfigComponentsTikv) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item config components tikv

type OpenapiClusterItemStatus 

type OpenapiClusterItemStatus struct {

	// Status of the cluster.
	// Example: AVAILABLE
	// Enum: [AVAILABLE CREATING MODIFYING PAUSED RESUMING UNAVAILABLE IMPORTING MAINTAINING PAUSING]
	ClusterStatus string `json:"cluster_status,omitempty"`

	// connection strings
	ConnectionStrings *OpenapiClusterItemStatusConnectionStrings `json:"connection_strings,omitempty"`

	// node map
	NodeMap *OpenapiClusterItemStatusNodeMap `json:"node_map,omitempty"`

	// TiDB version.
	// Example: v6.1.0
	TidbVersion string `json:"tidb_version,omitempty"`
}

OpenapiClusterItemStatus ClusterItemStatus

ClusterItemStatus is the status of cluster.

swagger:model openapiClusterItemStatus

func (*OpenapiClusterItemStatus) ContextValidate 

func (m *OpenapiClusterItemStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster item status based on the context it is used

func (*OpenapiClusterItemStatus) MarshalBinary 

func (m *OpenapiClusterItemStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatus) UnmarshalBinary 

func (m *OpenapiClusterItemStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatus) Validate 

func (m *OpenapiClusterItemStatus) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status

type OpenapiClusterItemStatusConnectionStrings 

type OpenapiClusterItemStatusConnectionStrings struct {

	// The default TiDB user for connection.
	// Example: root
	DefaultUser string `json:"default_user,omitempty"`

	// standard
	Standard *OpenapiClusterItemStatusConnectionStringsStandard `json:"standard,omitempty"`

	// vpc peering
	VpcPeering *OpenapiClusterItemStatusConnectionStringsVpcPeering `json:"vpc_peering,omitempty"`
}

OpenapiClusterItemStatusConnectionStrings Connection strings.

swagger:model OpenapiClusterItemStatusConnectionStrings

func (*OpenapiClusterItemStatusConnectionStrings) ContextValidate 

func (m *OpenapiClusterItemStatusConnectionStrings) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster item status connection strings based on the context it is used

func (*OpenapiClusterItemStatusConnectionStrings) MarshalBinary 

func (m *OpenapiClusterItemStatusConnectionStrings) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatusConnectionStrings) UnmarshalBinary 

func (m *OpenapiClusterItemStatusConnectionStrings) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatusConnectionStrings) Validate 

func (m *OpenapiClusterItemStatusConnectionStrings) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status connection strings

type OpenapiClusterItemStatusConnectionStringsStandard 

type OpenapiClusterItemStatusConnectionStringsStandard struct {

	// The host of standard connection.
	// Example: tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiClusterItemStatusConnectionStringsStandard Standard connection string.

You must configure the [IP Access List](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster#connect-via-standard-connection) for the cluster you created on [TiDB Cloud console](https://tidbcloud.com/) before connecting to this connection string.

swagger:model OpenapiClusterItemStatusConnectionStringsStandard

func (*OpenapiClusterItemStatusConnectionStringsStandard) ContextValidate 

func (m *OpenapiClusterItemStatusConnectionStringsStandard) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item status connection strings standard based on context it is used

func (*OpenapiClusterItemStatusConnectionStringsStandard) MarshalBinary 

func (m *OpenapiClusterItemStatusConnectionStringsStandard) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatusConnectionStringsStandard) UnmarshalBinary 

func (m *OpenapiClusterItemStatusConnectionStringsStandard) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatusConnectionStringsStandard) Validate 

func (m *OpenapiClusterItemStatusConnectionStringsStandard) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status connection strings standard

type OpenapiClusterItemStatusConnectionStringsVpcPeering 

type OpenapiClusterItemStatusConnectionStringsVpcPeering struct {

	// The host of VPC peering connection.
	// Example: private-tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiClusterItemStatusConnectionStringsVpcPeering [VPC peering](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary#vpc-peering) connection string.

You must [Set up VPC peering connections](https://docs.pingcap.com/tidbcloud/set-up-vpc-peering-connections) for the project before connecting to this private connection string.

swagger:model OpenapiClusterItemStatusConnectionStringsVpcPeering

func (*OpenapiClusterItemStatusConnectionStringsVpcPeering) ContextValidate 

func (m *OpenapiClusterItemStatusConnectionStringsVpcPeering) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item status connection strings vpc peering based on context it is used

func (*OpenapiClusterItemStatusConnectionStringsVpcPeering) MarshalBinary 

func (m *OpenapiClusterItemStatusConnectionStringsVpcPeering) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatusConnectionStringsVpcPeering) UnmarshalBinary 

func (m *OpenapiClusterItemStatusConnectionStringsVpcPeering) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatusConnectionStringsVpcPeering) Validate 

func (m *OpenapiClusterItemStatusConnectionStringsVpcPeering) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status connection strings vpc peering

type OpenapiClusterItemStatusNodeMap 

type OpenapiClusterItemStatusNodeMap struct {

	// TiDB node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tidb-0","node_size":"8C16G","ram_bytes":"17179869184","status":"NODE_STATUS_AVAILABLE","vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tidb-1","node_size":"8C16G","ram_bytes":"17179869184","status":"NODE_STATUS_AVAILABLE","vcpu_num":8}]
	// Required: true
	Tidb []*OpenapiClusterItemStatusNodeMapTidbItems0 `json:"tidb"`

	// TiFlash node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tiflash-0","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tiflash-1","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8}]
	Tiflash []*OpenapiClusterItemStatusNodeMapTiflashItems0 `json:"tiflash"`

	// TiKV node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tikv-0","node_size":"8C32G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tikv-1","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2c","node_name":"tikv-2","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8}]
	// Required: true
	Tikv []*OpenapiClusterItemStatusNodeMapTikvItems0 `json:"tikv"`
}

OpenapiClusterItemStatusNodeMap Node map. The `node_map` is returned only when the `cluster_status` is `"AVAILABLE"` or `"MODIFYING"`.

swagger:model OpenapiClusterItemStatusNodeMap

func (*OpenapiClusterItemStatusNodeMap) ContextValidate 

func (m *OpenapiClusterItemStatusNodeMap) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster item status node map based on the context it is used

func (*OpenapiClusterItemStatusNodeMap) MarshalBinary 

func (m *OpenapiClusterItemStatusNodeMap) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMap) UnmarshalBinary 

func (m *OpenapiClusterItemStatusNodeMap) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMap) Validate 

func (m *OpenapiClusterItemStatusNodeMap) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status node map

type OpenapiClusterItemStatusNodeMapTidbItems0 

type OpenapiClusterItemStatusNodeMapTidbItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tidb-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiDB component in the cluster.
	// Example: 8C16G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 17179869184
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiClusterItemStatusNodeMapTidbItems0 openapi cluster item status node map tidb items0

swagger:model OpenapiClusterItemStatusNodeMapTidbItems0

func (*OpenapiClusterItemStatusNodeMapTidbItems0) ContextValidate 

func (m *OpenapiClusterItemStatusNodeMapTidbItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item status node map tidb items0 based on context it is used

func (*OpenapiClusterItemStatusNodeMapTidbItems0) MarshalBinary 

func (m *OpenapiClusterItemStatusNodeMapTidbItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMapTidbItems0) UnmarshalBinary 

func (m *OpenapiClusterItemStatusNodeMapTidbItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMapTidbItems0) Validate 

func (m *OpenapiClusterItemStatusNodeMapTidbItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status node map tidb items0

type OpenapiClusterItemStatusNodeMapTiflashItems0 

type OpenapiClusterItemStatusNodeMapTiflashItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tiflash-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiFlash component in the cluster.
	// Example: 8C64G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiClusterItemStatusNodeMapTiflashItems0 openapi cluster item status node map tiflash items0

swagger:model OpenapiClusterItemStatusNodeMapTiflashItems0

func (*OpenapiClusterItemStatusNodeMapTiflashItems0) ContextValidate 

func (m *OpenapiClusterItemStatusNodeMapTiflashItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item status node map tiflash items0 based on context it is used

func (*OpenapiClusterItemStatusNodeMapTiflashItems0) MarshalBinary 

func (m *OpenapiClusterItemStatusNodeMapTiflashItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMapTiflashItems0) UnmarshalBinary 

func (m *OpenapiClusterItemStatusNodeMapTiflashItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMapTiflashItems0) Validate 

func (m *OpenapiClusterItemStatusNodeMapTiflashItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status node map tiflash items0

type OpenapiClusterItemStatusNodeMapTikvItems0 

type OpenapiClusterItemStatusNodeMapTikvItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tikv-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiKV component in the cluster.
	// Example: 8C32G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiClusterItemStatusNodeMapTikvItems0 openapi cluster item status node map tikv items0

swagger:model OpenapiClusterItemStatusNodeMapTikvItems0

func (*OpenapiClusterItemStatusNodeMapTikvItems0) ContextValidate 

func (m *OpenapiClusterItemStatusNodeMapTikvItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster item status node map tikv items0 based on context it is used

func (*OpenapiClusterItemStatusNodeMapTikvItems0) MarshalBinary 

func (m *OpenapiClusterItemStatusNodeMapTikvItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMapTikvItems0) UnmarshalBinary 

func (m *OpenapiClusterItemStatusNodeMapTikvItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterItemStatusNodeMapTikvItems0) Validate 

func (m *OpenapiClusterItemStatusNodeMapTikvItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster item status node map tikv items0

type OpenapiClusterNodeMap 

type OpenapiClusterNodeMap struct {

	// TiDB node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tidb-0","node_size":"8C16G","ram_bytes":"17179869184","status":"NODE_STATUS_AVAILABLE","vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tidb-1","node_size":"8C16G","ram_bytes":"17179869184","status":"NODE_STATUS_AVAILABLE","vcpu_num":8}]
	// Required: true
	Tidb []*OpenapiClusterNodeMapTidbItems0 `json:"tidb"`

	// TiFlash node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tiflash-0","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tiflash-1","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8}]
	Tiflash []*OpenapiClusterNodeMapTiflashItems0 `json:"tiflash"`

	// TiKV node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tikv-0","node_size":"8C32G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tikv-1","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2c","node_name":"tikv-2","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8}]
	// Required: true
	Tikv []*OpenapiClusterNodeMapTikvItems0 `json:"tikv"`
}

OpenapiClusterNodeMap openapi cluster node map

swagger:model openapiClusterNodeMap

func (*OpenapiClusterNodeMap) ContextValidate 

func (m *OpenapiClusterNodeMap) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi cluster node map based on the context it is used

func (*OpenapiClusterNodeMap) MarshalBinary 

func (m *OpenapiClusterNodeMap) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterNodeMap) UnmarshalBinary 

func (m *OpenapiClusterNodeMap) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterNodeMap) Validate 

func (m *OpenapiClusterNodeMap) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster node map

type OpenapiClusterNodeMapTidbItems0 

type OpenapiClusterNodeMapTidbItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tidb-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiDB component in the cluster.
	// Example: 8C16G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 17179869184
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiClusterNodeMapTidbItems0 openapi cluster node map tidb items0

swagger:model OpenapiClusterNodeMapTidbItems0

func (*OpenapiClusterNodeMapTidbItems0) ContextValidate 

func (m *OpenapiClusterNodeMapTidbItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster node map tidb items0 based on context it is used

func (*OpenapiClusterNodeMapTidbItems0) MarshalBinary 

func (m *OpenapiClusterNodeMapTidbItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterNodeMapTidbItems0) UnmarshalBinary 

func (m *OpenapiClusterNodeMapTidbItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterNodeMapTidbItems0) Validate 

func (m *OpenapiClusterNodeMapTidbItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster node map tidb items0

type OpenapiClusterNodeMapTiflashItems0 

type OpenapiClusterNodeMapTiflashItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tiflash-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiFlash component in the cluster.
	// Example: 8C64G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiClusterNodeMapTiflashItems0 openapi cluster node map tiflash items0

swagger:model OpenapiClusterNodeMapTiflashItems0

func (*OpenapiClusterNodeMapTiflashItems0) ContextValidate 

func (m *OpenapiClusterNodeMapTiflashItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster node map tiflash items0 based on context it is used

func (*OpenapiClusterNodeMapTiflashItems0) MarshalBinary 

func (m *OpenapiClusterNodeMapTiflashItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterNodeMapTiflashItems0) UnmarshalBinary 

func (m *OpenapiClusterNodeMapTiflashItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterNodeMapTiflashItems0) Validate 

func (m *OpenapiClusterNodeMapTiflashItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster node map tiflash items0

type OpenapiClusterNodeMapTikvItems0 

type OpenapiClusterNodeMapTikvItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tikv-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiKV component in the cluster.
	// Example: 8C32G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiClusterNodeMapTikvItems0 openapi cluster node map tikv items0

swagger:model OpenapiClusterNodeMapTikvItems0

func (*OpenapiClusterNodeMapTikvItems0) ContextValidate 

func (m *OpenapiClusterNodeMapTikvItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster node map tikv items0 based on context it is used

func (*OpenapiClusterNodeMapTikvItems0) MarshalBinary 

func (m *OpenapiClusterNodeMapTikvItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiClusterNodeMapTikvItems0) UnmarshalBinary 

func (m *OpenapiClusterNodeMapTikvItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiClusterNodeMapTikvItems0) Validate 

func (m *OpenapiClusterNodeMapTikvItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster node map tikv items0

type OpenapiClusterStatus 

type OpenapiClusterStatus string

OpenapiClusterStatus openapi cluster status

swagger:model openapiClusterStatus 

const (

	// OpenapiClusterStatusAVAILABLE captures enum value "AVAILABLE"
	OpenapiClusterStatusAVAILABLE OpenapiClusterStatus = "AVAILABLE"

	// OpenapiClusterStatusCREATING captures enum value "CREATING"
	OpenapiClusterStatusCREATING OpenapiClusterStatus = "CREATING"

	// OpenapiClusterStatusMODIFYING captures enum value "MODIFYING"
	OpenapiClusterStatusMODIFYING OpenapiClusterStatus = "MODIFYING"

	// OpenapiClusterStatusPAUSED captures enum value "PAUSED"
	OpenapiClusterStatusPAUSED OpenapiClusterStatus = "PAUSED"

	// OpenapiClusterStatusRESUMING captures enum value "RESUMING"
	OpenapiClusterStatusRESUMING OpenapiClusterStatus = "RESUMING"

	// OpenapiClusterStatusUNAVAILABLE captures enum value "UNAVAILABLE"
	OpenapiClusterStatusUNAVAILABLE OpenapiClusterStatus = "UNAVAILABLE"

	// OpenapiClusterStatusIMPORTING captures enum value "IMPORTING"
	OpenapiClusterStatusIMPORTING OpenapiClusterStatus = "IMPORTING"

	// OpenapiClusterStatusMAINTAINING captures enum value "MAINTAINING"
	OpenapiClusterStatusMAINTAINING OpenapiClusterStatus = "MAINTAINING"

	// OpenapiClusterStatusPAUSING captures enum value "PAUSING"
	OpenapiClusterStatusPAUSING OpenapiClusterStatus = "PAUSING"
)

func NewOpenapiClusterStatus 

func NewOpenapiClusterStatus(value OpenapiClusterStatus) *OpenapiClusterStatus

func (OpenapiClusterStatus) ContextValidate 

func (m OpenapiClusterStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster status based on context it is used

func (OpenapiClusterStatus) Pointer 

func (m OpenapiClusterStatus) Pointer() *OpenapiClusterStatus

Pointer returns a pointer to a freshly-allocated OpenapiClusterStatus.

func (OpenapiClusterStatus) Validate 

func (m OpenapiClusterStatus) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster status

type OpenapiClusterType 

type OpenapiClusterType string

OpenapiClusterType openapi cluster type

swagger:model openapiClusterType 

const (

	// OpenapiClusterTypeDEDICATED captures enum value "DEDICATED"
	OpenapiClusterTypeDEDICATED OpenapiClusterType = "DEDICATED"

	// OpenapiClusterTypeDEVELOPER captures enum value "DEVELOPER"
	OpenapiClusterTypeDEVELOPER OpenapiClusterType = "DEVELOPER"
)

func NewOpenapiClusterType 

func NewOpenapiClusterType(value OpenapiClusterType) *OpenapiClusterType

func (OpenapiClusterType) ContextValidate 

func (m OpenapiClusterType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi cluster type based on context it is used

func (OpenapiClusterType) Pointer 

func (m OpenapiClusterType) Pointer() *OpenapiClusterType

Pointer returns a pointer to a freshly-allocated OpenapiClusterType.

func (OpenapiClusterType) Validate 

func (m OpenapiClusterType) Validate(formats strfmt.Registry) error

Validate validates this openapi cluster type

type OpenapiColumnDefinition 

type OpenapiColumnDefinition struct {

	// The column name.
	// Example: column01
	// Required: true
	ColumnName *string `json:"column_name"`

	// The column type.
	// Example: VARCHAR(255)
	// Required: true
	ColumnType *string `json:"column_type"`
}

OpenapiColumnDefinition ColumnDefinition

ColumnDefinition is the definition of a column in a table.

swagger:model openapiColumnDefinition

func (*OpenapiColumnDefinition) ContextValidate 

func (m *OpenapiColumnDefinition) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi column definition based on context it is used

func (*OpenapiColumnDefinition) MarshalBinary 

func (m *OpenapiColumnDefinition) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiColumnDefinition) UnmarshalBinary 

func (m *OpenapiColumnDefinition) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiColumnDefinition) Validate 

func (m *OpenapiColumnDefinition) Validate(formats strfmt.Registry) error

Validate validates this openapi column definition

type OpenapiCreateBackupResp 

type OpenapiCreateBackupResp struct {

	// The ID of the backup.
	// Example: 1
	ID string `json:"id,omitempty"`
}

OpenapiCreateBackupResp CreateBackupResp

This response for creating a MANUAL type backup.

swagger:model openapiCreateBackupResp

func (*OpenapiCreateBackupResp) ContextValidate 

func (m *OpenapiCreateBackupResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create backup resp based on context it is used

func (*OpenapiCreateBackupResp) MarshalBinary 

func (m *OpenapiCreateBackupResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateBackupResp) UnmarshalBinary 

func (m *OpenapiCreateBackupResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateBackupResp) Validate 

func (m *OpenapiCreateBackupResp) Validate(formats strfmt.Registry) error

Validate validates this openapi create backup resp

type OpenapiCreateClusterResp 

type OpenapiCreateClusterResp struct {

	// The ID of the cluster.
	// Example: 1
	// Required: true
	ID *string `json:"id"`
}

OpenapiCreateClusterResp CreateClusterResp

CreateClusterResp is the response for creating cluster.

swagger:model openapiCreateClusterResp

func (*OpenapiCreateClusterResp) ContextValidate 

func (m *OpenapiCreateClusterResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create cluster resp based on context it is used

func (*OpenapiCreateClusterResp) MarshalBinary 

func (m *OpenapiCreateClusterResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateClusterResp) UnmarshalBinary 

func (m *OpenapiCreateClusterResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateClusterResp) Validate 

func (m *OpenapiCreateClusterResp) Validate(formats strfmt.Registry) error

Validate validates this openapi create cluster resp

type OpenapiCreateImportTaskOptions 

type OpenapiCreateImportTaskOptions struct {

	// The table definition of pre-created tables.
	//
	// **Note**: The name of the pre-created tables should match one of the target tables. Otherwise, the table will be ignored and won't be created
	PreCreateTables []*OpenapiCreateImportTaskOptionsPreCreateTablesItems0 `json:"pre_create_tables"`
}

OpenapiCreateImportTaskOptions CreateImportTaskOptions

CreateImportTaskOptions is the optional configuration for creating an import task.

swagger:model openapiCreateImportTaskOptions

func (*OpenapiCreateImportTaskOptions) ContextValidate 

func (m *OpenapiCreateImportTaskOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi create import task options based on the context it is used

func (*OpenapiCreateImportTaskOptions) MarshalBinary 

func (m *OpenapiCreateImportTaskOptions) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptions) UnmarshalBinary 

func (m *OpenapiCreateImportTaskOptions) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptions) Validate 

func (m *OpenapiCreateImportTaskOptions) Validate(formats strfmt.Registry) error

Validate validates this openapi create import task options

type OpenapiCreateImportTaskOptionsPreCreateTablesItems0 

type OpenapiCreateImportTaskOptionsPreCreateTablesItems0 struct {

	// The database name of the table.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// schema
	// Required: true
	Schema *OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema `json:"schema"`

	// The table name of the table.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiCreateImportTaskOptionsPreCreateTablesItems0 TableDefinition

TableDefinition is the definition of a table so that the table can be created with this information.

swagger:model OpenapiCreateImportTaskOptionsPreCreateTablesItems0

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0) ContextValidate 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi create import task options pre create tables items0 based on the context it is used

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0) MarshalBinary 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0) UnmarshalBinary 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0) Validate 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi create import task options pre create tables items0

type OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema 

type OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema struct {

	// The column definition for each column in the table.
	// Example: [{"column_name":"id","column_type":"INTEGER"},{"column_name":"column01","column_type":"VARCHAR(255)"}]
	// Required: true
	ColumnDefinitions []*OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0 `json:"column_definitions"`

	// The primary key column names for the table. This is optional. The primary key is taken into account when the table is pre-created before an import task is started.
	// Example: ["id"]
	PrimaryKeyColumns []string `json:"primary_key_columns"`
}

OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema TableSchema

The schema for the table.

swagger:model OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) ContextValidate 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi create import task options pre create tables items0 schema based on the context it is used

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) MarshalBinary 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) UnmarshalBinary 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) Validate 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0Schema) Validate(formats strfmt.Registry) error

Validate validates this openapi create import task options pre create tables items0 schema

type OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0 

type OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0 struct {

	// The column name.
	// Example: column01
	// Required: true
	ColumnName *string `json:"column_name"`

	// The column type.
	// Example: VARCHAR(255)
	// Required: true
	ColumnType *string `json:"column_type"`
}

OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0 ColumnDefinition

ColumnDefinition is the definition of a column in a table.

swagger:model OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) ContextValidate 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create import task options pre create tables items0 schema column definitions items0 based on context it is used

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) MarshalBinary 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) UnmarshalBinary 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) Validate 

func (m *OpenapiCreateImportTaskOptionsPreCreateTablesItems0SchemaColumnDefinitionsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi create import task options pre create tables items0 schema column definitions items0

type OpenapiCreateImportTaskResp 

type OpenapiCreateImportTaskResp struct {

	// The ID of the import task.
	// Example: 12345
	// Required: true
	ID *string `json:"id"`
}

OpenapiCreateImportTaskResp CreateImportTaskResp

CreateImportTaskResp is the response to the creation of an import task.

swagger:model openapiCreateImportTaskResp

func (*OpenapiCreateImportTaskResp) ContextValidate 

func (m *OpenapiCreateImportTaskResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create import task resp based on context it is used

func (*OpenapiCreateImportTaskResp) MarshalBinary 

func (m *OpenapiCreateImportTaskResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateImportTaskResp) UnmarshalBinary 

func (m *OpenapiCreateImportTaskResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateImportTaskResp) Validate 

func (m *OpenapiCreateImportTaskResp) Validate(formats strfmt.Registry) error

Validate validates this openapi create import task resp

type OpenapiCreatePrivateEndpointResp 

type OpenapiCreatePrivateEndpointResp struct {

	// private endpoint
	// Required: true
	PrivateEndpoint *OpenapiCreatePrivateEndpointRespPrivateEndpoint `json:"private_endpoint"`
}

OpenapiCreatePrivateEndpointResp CreatePrivateEndpointResp

CreatePrivateEndpointResp is the response for creating a private endpoint for a private endpoint service.

swagger:model openapiCreatePrivateEndpointResp

func (*OpenapiCreatePrivateEndpointResp) ContextValidate 

func (m *OpenapiCreatePrivateEndpointResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi create private endpoint resp based on the context it is used

func (*OpenapiCreatePrivateEndpointResp) MarshalBinary 

func (m *OpenapiCreatePrivateEndpointResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointResp) UnmarshalBinary 

func (m *OpenapiCreatePrivateEndpointResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointResp) Validate 

func (m *OpenapiCreatePrivateEndpointResp) Validate(formats strfmt.Registry) error

Validate validates this openapi create private endpoint resp

type OpenapiCreatePrivateEndpointRespPrivateEndpoint 

type OpenapiCreatePrivateEndpointRespPrivateEndpoint struct {

	// [Output Only] The cloud provider on which the private endpoint service is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// [Output Only] The ID of the cluster.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// [Output Only] The name of the cluster.
	// Example: Cluster0
	ClusterName string `json:"cluster_name,omitempty"`

	// The format of the private endpoint name varies by cloud provider: `"vpce-xxxx"` for AWS and `"projects/xxx/regions/xxx/forwardingRules/xxx"` for Google Cloud.
	// Example: vpce-01234567890123456
	EndpointName string `json:"endpoint_name,omitempty"`

	// [Output Only] The ID of private endpoint. It is used when you [deleting the endpoint](#tag/Cluster/operation/DeletePrivateEndpoint).
	// Example: 1
	ID string `json:"id,omitempty"`

	// [Output Only] The detailed message when the `status` is "FAILED".
	// Example: The endpoint does not exist.
	Message string `json:"message,omitempty"`

	// [Output Only] The region where the private endpoint is hosted, such as Oregon in AWS.
	// Example: Oregon
	RegionName string `json:"region_name,omitempty"`

	// [Output Only] The service name of the private endpoint.
	// Example: com.amazonaws.vpce.us-west-2.vpce-svc-01234567890123456
	ServiceName string `json:"service_name,omitempty"`

	// [Output Only] The status of the private endpoint service.
	// Example: ACTIVE
	// Enum: [CREATING ACTIVE DELETING]
	ServiceStatus string `json:"service_status,omitempty"`

	// [Output Only] The status of the private endpoint.
	// Example: FAILED
	// Enum: [PENDING ACTIVE DELETING FAILED]
	Status string `json:"status,omitempty"`
}

OpenapiCreatePrivateEndpointRespPrivateEndpoint The newly endpoint created resource.

swagger:model OpenapiCreatePrivateEndpointRespPrivateEndpoint

func (*OpenapiCreatePrivateEndpointRespPrivateEndpoint) ContextValidate 

func (m *OpenapiCreatePrivateEndpointRespPrivateEndpoint) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create private endpoint resp private endpoint based on context it is used

func (*OpenapiCreatePrivateEndpointRespPrivateEndpoint) MarshalBinary 

func (m *OpenapiCreatePrivateEndpointRespPrivateEndpoint) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointRespPrivateEndpoint) UnmarshalBinary 

func (m *OpenapiCreatePrivateEndpointRespPrivateEndpoint) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointRespPrivateEndpoint) Validate 

func (m *OpenapiCreatePrivateEndpointRespPrivateEndpoint) Validate(formats strfmt.Registry) error

Validate validates this openapi create private endpoint resp private endpoint

type OpenapiCreatePrivateEndpointServiceResp 

type OpenapiCreatePrivateEndpointServiceResp struct {

	// private endpoint service
	// Required: true
	PrivateEndpointService *OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService `json:"private_endpoint_service"`
}

OpenapiCreatePrivateEndpointServiceResp CreatePrivateEndpointServiceResp

CreatePrivateEndpointServiceResp is the response for creating private endpoint service for a cluster.

swagger:model openapiCreatePrivateEndpointServiceResp

func (*OpenapiCreatePrivateEndpointServiceResp) ContextValidate 

func (m *OpenapiCreatePrivateEndpointServiceResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi create private endpoint service resp based on the context it is used

func (*OpenapiCreatePrivateEndpointServiceResp) MarshalBinary 

func (m *OpenapiCreatePrivateEndpointServiceResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointServiceResp) UnmarshalBinary 

func (m *OpenapiCreatePrivateEndpointServiceResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointServiceResp) Validate 

func (m *OpenapiCreatePrivateEndpointServiceResp) Validate(formats strfmt.Registry) error

Validate validates this openapi create private endpoint service resp

type OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService 

type OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService struct {

	// Availability zones for the private endpoint service. This field is only applicable when the `cloud_provider` is `"AWS"`.
	// Example: ["usw2-az2","usw2-az1"]
	AzIds []string `json:"az_ids"`

	// The cloud provider on which the private endpoint service is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// The DNS name of the private endpoint service.
	// Example: privatelink-tidb.01234567890.clusters.tidb-cloud.com
	DNSName string `json:"dns_name,omitempty"`

	// The name of the private endpoint service, which is used for connection.
	// Example: com.amazonaws.vpce.us-west-2.vpce-svc-01234567890123456
	Name string `json:"name,omitempty"`

	// The port of the private endpoint service.
	// Example: 4000
	Port int32 `json:"port,omitempty"`

	// The status of the private endpoint service.
	// Example: ACTIVE
	// Enum: [CREATING ACTIVE DELETING]
	Status string `json:"status,omitempty"`
}

OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService The newly created private endpoint service resource.

swagger:model OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService

func (*OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) ContextValidate 

func (m *OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create private endpoint service resp private endpoint service based on context it is used

func (*OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) MarshalBinary 

func (m *OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) UnmarshalBinary 

func (m *OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) Validate 

func (m *OpenapiCreatePrivateEndpointServiceRespPrivateEndpointService) Validate(formats strfmt.Registry) error

Validate validates this openapi create private endpoint service resp private endpoint service

type OpenapiCreateProjectReq 

type OpenapiCreateProjectReq struct {

	// Flag that indicates whether to enable AWS Customer-Managed Encryption Keys.
	//
	// Currently this feature is only available upon request. If you need to try out this feature, contact [support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support).
	// Example: false
	AwsCmekEnabled *bool `json:"aws_cmek_enabled,omitempty"`

	// The name of the project.
	// Example: Project0
	// Required: true
	Name *string `json:"name"`
}

OpenapiCreateProjectReq CreateProjectReq

CreateProjectReq is the request for creating project.

swagger:model openapiCreateProjectReq

func (*OpenapiCreateProjectReq) ContextValidate 

func (m *OpenapiCreateProjectReq) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create project req based on context it is used

func (*OpenapiCreateProjectReq) MarshalBinary 

func (m *OpenapiCreateProjectReq) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateProjectReq) UnmarshalBinary 

func (m *OpenapiCreateProjectReq) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateProjectReq) Validate 

func (m *OpenapiCreateProjectReq) Validate(formats strfmt.Registry) error

Validate validates this openapi create project req

type OpenapiCreateProjectResp 

type OpenapiCreateProjectResp struct {

	// The ID of the project.
	// Example: 1
	// Required: true
	ID *string `json:"id"`
}

OpenapiCreateProjectResp CreateProjectResp

CreateProjectResp is the response for creating project.

swagger:model openapiCreateProjectResp

func (*OpenapiCreateProjectResp) ContextValidate 

func (m *OpenapiCreateProjectResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create project resp based on context it is used

func (*OpenapiCreateProjectResp) MarshalBinary 

func (m *OpenapiCreateProjectResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateProjectResp) UnmarshalBinary 

func (m *OpenapiCreateProjectResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateProjectResp) Validate 

func (m *OpenapiCreateProjectResp) Validate(formats strfmt.Registry) error

Validate validates this openapi create project resp

type OpenapiCreateRestoreResp 

type OpenapiCreateRestoreResp struct {

	// The ID of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// The ID of the restore task.
	// Example: 1
	ID string `json:"id,omitempty"`
}

OpenapiCreateRestoreResp CreateRestoreResp

CreateRestoreResp is the response for restoring backup to a new cluster.

swagger:model openapiCreateRestoreResp

func (*OpenapiCreateRestoreResp) ContextValidate 

func (m *OpenapiCreateRestoreResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi create restore resp based on context it is used

func (*OpenapiCreateRestoreResp) MarshalBinary 

func (m *OpenapiCreateRestoreResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiCreateRestoreResp) UnmarshalBinary 

func (m *OpenapiCreateRestoreResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiCreateRestoreResp) Validate 

func (m *OpenapiCreateRestoreResp) Validate(formats strfmt.Registry) error

Validate validates this openapi create restore resp

type OpenapiGcpImportTaskRoleInfo 

type OpenapiGcpImportTaskRoleInfo struct {

	// The account ID under which the import tasks for this cluster are running.
	// Example: example-account@example.com
	// Required: true
	AccountID *string `json:"account_id"`
}

OpenapiGcpImportTaskRoleInfo GcpImportTaskRoleInfo

GcpImportTaskRoleInfo is the role information for import tasks on a GCP cluster.

swagger:model openapiGcpImportTaskRoleInfo

func (*OpenapiGcpImportTaskRoleInfo) ContextValidate 

func (m *OpenapiGcpImportTaskRoleInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi gcp import task role info based on context it is used

func (*OpenapiGcpImportTaskRoleInfo) MarshalBinary 

func (m *OpenapiGcpImportTaskRoleInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGcpImportTaskRoleInfo) UnmarshalBinary 

func (m *OpenapiGcpImportTaskRoleInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGcpImportTaskRoleInfo) Validate 

func (m *OpenapiGcpImportTaskRoleInfo) Validate(formats strfmt.Registry) error

Validate validates this openapi gcp import task role info

type OpenapiGetBackupOfClusterResp 

type OpenapiGetBackupOfClusterResp struct {

	// The creation time of the backup in UTC. The time format follows the [ISO8601](http://en.wikipedia.org/wiki/ISO_8601) standard, which is `YYYY-MM-DD` (year-month-day) + T +`HH:MM:SS` (hour-minutes-seconds) + Z. For example, `2020-01-01T00:00:00Z`.
	// Example: 2020-01-01T00:00:00Z
	// Format: date-time
	CreateTimestamp strfmt.DateTime `json:"create_timestamp,omitempty"`

	// The description of the backup. It is specified by the user when taking a manual type backup. It helps you add additional information to the backup.
	// Example: backup for cluster upgrade in 2022/06/07
	Description string `json:"description,omitempty"`

	// The ID of the backup.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the backup.
	// Example: backup-1
	Name string `json:"name,omitempty"`

	// The bytes of the backup.
	// Example: 102400
	Size string `json:"size,omitempty"`

	// The status of backup.
	// Example: SUCCESS
	// Enum: [PENDING RUNNING FAILED SUCCESS]
	Status string `json:"status,omitempty"`

	// The type of backup. TiDB Cloud only supports manual and auto backup. For more information, see [TiDB Cloud Documentation](https://docs.pingcap.com/tidbcloud/backup-and-restore#backup).
	// Example: MANUAL
	// Enum: [MANUAL AUTO]
	Type string `json:"type,omitempty"`
}

OpenapiGetBackupOfClusterResp GetBackupOfClusterResp

This response for getting backup of a cluster.

swagger:model openapiGetBackupOfClusterResp

func (*OpenapiGetBackupOfClusterResp) ContextValidate 

func (m *OpenapiGetBackupOfClusterResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get backup of cluster resp based on context it is used

func (*OpenapiGetBackupOfClusterResp) MarshalBinary 

func (m *OpenapiGetBackupOfClusterResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetBackupOfClusterResp) UnmarshalBinary 

func (m *OpenapiGetBackupOfClusterResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetBackupOfClusterResp) Validate 

func (m *OpenapiGetBackupOfClusterResp) Validate(formats strfmt.Registry) error

Validate validates this openapi get backup of cluster resp

type OpenapiGetBackupOfClusterRespStatusEnum 

type OpenapiGetBackupOfClusterRespStatusEnum string

OpenapiGetBackupOfClusterRespStatusEnum openapi get backup of cluster resp status enum

swagger:model openapiGetBackupOfClusterRespStatusEnum 

const (

	// OpenapiGetBackupOfClusterRespStatusEnumPENDING captures enum value "PENDING"
	OpenapiGetBackupOfClusterRespStatusEnumPENDING OpenapiGetBackupOfClusterRespStatusEnum = "PENDING"

	// OpenapiGetBackupOfClusterRespStatusEnumRUNNING captures enum value "RUNNING"
	OpenapiGetBackupOfClusterRespStatusEnumRUNNING OpenapiGetBackupOfClusterRespStatusEnum = "RUNNING"

	// OpenapiGetBackupOfClusterRespStatusEnumFAILED captures enum value "FAILED"
	OpenapiGetBackupOfClusterRespStatusEnumFAILED OpenapiGetBackupOfClusterRespStatusEnum = "FAILED"

	// OpenapiGetBackupOfClusterRespStatusEnumSUCCESS captures enum value "SUCCESS"
	OpenapiGetBackupOfClusterRespStatusEnumSUCCESS OpenapiGetBackupOfClusterRespStatusEnum = "SUCCESS"
)

func NewOpenapiGetBackupOfClusterRespStatusEnum 

func NewOpenapiGetBackupOfClusterRespStatusEnum(value OpenapiGetBackupOfClusterRespStatusEnum) *OpenapiGetBackupOfClusterRespStatusEnum

func (OpenapiGetBackupOfClusterRespStatusEnum) ContextValidate 

func (m OpenapiGetBackupOfClusterRespStatusEnum) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get backup of cluster resp status enum based on context it is used

func (OpenapiGetBackupOfClusterRespStatusEnum) Pointer 

func (m OpenapiGetBackupOfClusterRespStatusEnum) Pointer() *OpenapiGetBackupOfClusterRespStatusEnum

Pointer returns a pointer to a freshly-allocated OpenapiGetBackupOfClusterRespStatusEnum.

func (OpenapiGetBackupOfClusterRespStatusEnum) Validate 

func (m OpenapiGetBackupOfClusterRespStatusEnum) Validate(formats strfmt.Registry) error

Validate validates this openapi get backup of cluster resp status enum

type OpenapiGetClusterConfig 

type OpenapiGetClusterConfig struct {

	// components
	Components *OpenapiGetClusterConfigComponents `json:"components,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiGetClusterConfig openapi get cluster config

swagger:model openapiGetClusterConfig

func (*OpenapiGetClusterConfig) ContextValidate 

func (m *OpenapiGetClusterConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi get cluster config based on the context it is used

func (*OpenapiGetClusterConfig) MarshalBinary 

func (m *OpenapiGetClusterConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetClusterConfig) UnmarshalBinary 

func (m *OpenapiGetClusterConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetClusterConfig) Validate 

func (m *OpenapiGetClusterConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi get cluster config

type OpenapiGetClusterConfigComponents 

type OpenapiGetClusterConfigComponents struct {

	// tidb
	// Required: true
	Tidb *OpenapiGetClusterConfigComponentsTidb `json:"tidb"`

	// tiflash
	Tiflash *OpenapiGetClusterConfigComponentsTiflash `json:"tiflash,omitempty"`

	// tikv
	// Required: true
	Tikv *OpenapiGetClusterConfigComponentsTikv `json:"tikv"`
}

OpenapiGetClusterConfigComponents The components of the cluster. Example: {"tidb":{"node_quantity":2,"node_size":"8C16G"},"tikv":{"node_quantity":3,"node_size":"8C32G","storage_size_gib":1024}}

swagger:model OpenapiGetClusterConfigComponents

func (*OpenapiGetClusterConfigComponents) ContextValidate 

func (m *OpenapiGetClusterConfigComponents) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi get cluster config components based on the context it is used

func (*OpenapiGetClusterConfigComponents) MarshalBinary 

func (m *OpenapiGetClusterConfigComponents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponents) UnmarshalBinary 

func (m *OpenapiGetClusterConfigComponents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponents) Validate 

func (m *OpenapiGetClusterConfigComponents) Validate(formats strfmt.Registry) error

Validate validates this openapi get cluster config components

type OpenapiGetClusterConfigComponentsTidb 

type OpenapiGetClusterConfigComponentsTidb struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 2
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C16G
	// Required: true
	NodeSize *string `json:"node_size"`
}

OpenapiGetClusterConfigComponentsTidb The TiDB component of the cluster.

swagger:model OpenapiGetClusterConfigComponentsTidb

func (*OpenapiGetClusterConfigComponentsTidb) ContextValidate 

func (m *OpenapiGetClusterConfigComponentsTidb) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get cluster config components tidb based on context it is used

func (*OpenapiGetClusterConfigComponentsTidb) MarshalBinary 

func (m *OpenapiGetClusterConfigComponentsTidb) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponentsTidb) UnmarshalBinary 

func (m *OpenapiGetClusterConfigComponentsTidb) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponentsTidb) Validate 

func (m *OpenapiGetClusterConfigComponentsTidb) Validate(formats strfmt.Registry) error

Validate validates this openapi get cluster config components tidb

type OpenapiGetClusterConfigComponentsTiflash 

type OpenapiGetClusterConfigComponentsTiflash struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiGetClusterConfigComponentsTiflash The TiFlash component of the cluster.

swagger:model OpenapiGetClusterConfigComponentsTiflash

func (*OpenapiGetClusterConfigComponentsTiflash) ContextValidate 

func (m *OpenapiGetClusterConfigComponentsTiflash) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get cluster config components tiflash based on context it is used

func (*OpenapiGetClusterConfigComponentsTiflash) MarshalBinary 

func (m *OpenapiGetClusterConfigComponentsTiflash) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponentsTiflash) UnmarshalBinary 

func (m *OpenapiGetClusterConfigComponentsTiflash) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponentsTiflash) Validate 

func (m *OpenapiGetClusterConfigComponentsTiflash) Validate(formats strfmt.Registry) error

Validate validates this openapi get cluster config components tiflash

type OpenapiGetClusterConfigComponentsTikv 

type OpenapiGetClusterConfigComponentsTikv struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 3
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiGetClusterConfigComponentsTikv The TiKV component of the cluster.

swagger:model OpenapiGetClusterConfigComponentsTikv

func (*OpenapiGetClusterConfigComponentsTikv) ContextValidate 

func (m *OpenapiGetClusterConfigComponentsTikv) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get cluster config components tikv based on context it is used

func (*OpenapiGetClusterConfigComponentsTikv) MarshalBinary 

func (m *OpenapiGetClusterConfigComponentsTikv) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponentsTikv) UnmarshalBinary 

func (m *OpenapiGetClusterConfigComponentsTikv) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetClusterConfigComponentsTikv) Validate 

func (m *OpenapiGetClusterConfigComponentsTikv) Validate(formats strfmt.Registry) error

Validate validates this openapi get cluster config components tikv

type OpenapiGetPrivateEndpointServiceResp 

type OpenapiGetPrivateEndpointServiceResp struct {

	// private endpoint service
	// Required: true
	PrivateEndpointService *OpenapiGetPrivateEndpointServiceRespPrivateEndpointService `json:"private_endpoint_service"`
}

OpenapiGetPrivateEndpointServiceResp GetPrivateEndpointServiceResp

GetPrivateEndpointServiceResp is the response for getting private endpoint service for a cluster.

swagger:model openapiGetPrivateEndpointServiceResp

func (*OpenapiGetPrivateEndpointServiceResp) ContextValidate 

func (m *OpenapiGetPrivateEndpointServiceResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi get private endpoint service resp based on the context it is used

func (*OpenapiGetPrivateEndpointServiceResp) MarshalBinary 

func (m *OpenapiGetPrivateEndpointServiceResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetPrivateEndpointServiceResp) UnmarshalBinary 

func (m *OpenapiGetPrivateEndpointServiceResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetPrivateEndpointServiceResp) Validate 

func (m *OpenapiGetPrivateEndpointServiceResp) Validate(formats strfmt.Registry) error

Validate validates this openapi get private endpoint service resp

type OpenapiGetPrivateEndpointServiceRespPrivateEndpointService 

type OpenapiGetPrivateEndpointServiceRespPrivateEndpointService struct {

	// Availability zones for the private endpoint service. This field is only applicable when the `cloud_provider` is `"AWS"`.
	// Example: ["usw2-az2","usw2-az1"]
	AzIds []string `json:"az_ids"`

	// The cloud provider on which the private endpoint service is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// The DNS name of the private endpoint service.
	// Example: privatelink-tidb.01234567890.clusters.tidb-cloud.com
	DNSName string `json:"dns_name,omitempty"`

	// The name of the private endpoint service, which is used for connection.
	// Example: com.amazonaws.vpce.us-west-2.vpce-svc-01234567890123456
	Name string `json:"name,omitempty"`

	// The port of the private endpoint service.
	// Example: 4000
	Port int32 `json:"port,omitempty"`

	// The status of the private endpoint service.
	// Example: ACTIVE
	// Enum: [CREATING ACTIVE DELETING]
	Status string `json:"status,omitempty"`
}

OpenapiGetPrivateEndpointServiceRespPrivateEndpointService The private endpoint service resource of the cluster.

swagger:model OpenapiGetPrivateEndpointServiceRespPrivateEndpointService

func (*OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) ContextValidate 

func (m *OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get private endpoint service resp private endpoint service based on context it is used

func (*OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) MarshalBinary 

func (m *OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) UnmarshalBinary 

func (m *OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) Validate 

func (m *OpenapiGetPrivateEndpointServiceRespPrivateEndpointService) Validate(formats strfmt.Registry) error

Validate validates this openapi get private endpoint service resp private endpoint service

type OpenapiGetRestoreResp 

type OpenapiGetRestoreResp struct {

	// The ID of the backup.
	// Example: 1
	BackupID string `json:"backup_id,omitempty"`

	// cluster
	Cluster *OpenapiGetRestoreRespCluster `json:"cluster,omitempty"`

	// The cluster ID of the backup.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// The creation time of the backup in UTC.
	//
	// The time format follows the [ISO8601](http://en.wikipedia.org/wiki/ISO_8601) standard, which is `YYYY-MM-DD` (year-month-day) + T +`HH:MM:SS` (hour-minutes-seconds) + Z. For example, `2020-01-01T00:00:00Z`.
	// Example: 2020-01-01T00:00:00Z
	// Format: date-time
	CreateTimestamp strfmt.DateTime `json:"create_timestamp,omitempty"`

	// The error message of restore if failed.
	// Example: Please contact support.
	ErrorMessage string `json:"error_message,omitempty"`

	// The ID of the restore task.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The status of the restore task.
	// Example: PENDING
	// Enum: [PENDING RUNNING FAILED SUCCESS]
	Status string `json:"status,omitempty"`
}

OpenapiGetRestoreResp GetRestoreResp

The response for get restore.

swagger:model openapiGetRestoreResp

func (*OpenapiGetRestoreResp) ContextValidate 

func (m *OpenapiGetRestoreResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi get restore resp based on the context it is used

func (*OpenapiGetRestoreResp) MarshalBinary 

func (m *OpenapiGetRestoreResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetRestoreResp) UnmarshalBinary 

func (m *OpenapiGetRestoreResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetRestoreResp) Validate 

func (m *OpenapiGetRestoreResp) Validate(formats strfmt.Registry) error

Validate validates this openapi get restore resp

type OpenapiGetRestoreRespCluster 

type OpenapiGetRestoreRespCluster struct {

	// The ID of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: cluster-1
	Name string `json:"name,omitempty"`

	// The status of the restored cluster. Possible values are `"AVAILABLE"`, `"CREATING"`, `"MODIFYING"`, `"PAUSED"`, `"RESUMING"`, `"UNAVAILABLE"`, `"IMPORTING"`, and `"CLEARED"`.
	// Example: AVAILABLE
	Status string `json:"status,omitempty"`
}

OpenapiGetRestoreRespCluster ClusterInfoOfRestore

The information of the restored cluster. The restored cluster is the new cluster your backup data is restored to.

swagger:model OpenapiGetRestoreRespCluster

func (*OpenapiGetRestoreRespCluster) ContextValidate 

func (m *OpenapiGetRestoreRespCluster) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get restore resp cluster based on context it is used

func (*OpenapiGetRestoreRespCluster) MarshalBinary 

func (m *OpenapiGetRestoreRespCluster) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiGetRestoreRespCluster) UnmarshalBinary 

func (m *OpenapiGetRestoreRespCluster) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiGetRestoreRespCluster) Validate 

func (m *OpenapiGetRestoreRespCluster) Validate(formats strfmt.Registry) error

Validate validates this openapi get restore resp cluster

type OpenapiGetRestoreRespStatusEnum 

type OpenapiGetRestoreRespStatusEnum string

OpenapiGetRestoreRespStatusEnum openapi get restore resp status enum

swagger:model openapiGetRestoreRespStatusEnum 

const (

	// OpenapiGetRestoreRespStatusEnumPENDING captures enum value "PENDING"
	OpenapiGetRestoreRespStatusEnumPENDING OpenapiGetRestoreRespStatusEnum = "PENDING"

	// OpenapiGetRestoreRespStatusEnumRUNNING captures enum value "RUNNING"
	OpenapiGetRestoreRespStatusEnumRUNNING OpenapiGetRestoreRespStatusEnum = "RUNNING"

	// OpenapiGetRestoreRespStatusEnumFAILED captures enum value "FAILED"
	OpenapiGetRestoreRespStatusEnumFAILED OpenapiGetRestoreRespStatusEnum = "FAILED"

	// OpenapiGetRestoreRespStatusEnumSUCCESS captures enum value "SUCCESS"
	OpenapiGetRestoreRespStatusEnumSUCCESS OpenapiGetRestoreRespStatusEnum = "SUCCESS"
)

func NewOpenapiGetRestoreRespStatusEnum 

func NewOpenapiGetRestoreRespStatusEnum(value OpenapiGetRestoreRespStatusEnum) *OpenapiGetRestoreRespStatusEnum

func (OpenapiGetRestoreRespStatusEnum) ContextValidate 

func (m OpenapiGetRestoreRespStatusEnum) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi get restore resp status enum based on context it is used

func (OpenapiGetRestoreRespStatusEnum) Pointer 

func (m OpenapiGetRestoreRespStatusEnum) Pointer() *OpenapiGetRestoreRespStatusEnum

Pointer returns a pointer to a freshly-allocated OpenapiGetRestoreRespStatusEnum.

func (OpenapiGetRestoreRespStatusEnum) Validate 

func (m OpenapiGetRestoreRespStatusEnum) Validate(formats strfmt.Registry) error

Validate validates this openapi get restore resp status enum

type OpenapiIPAccessListItem 

type OpenapiIPAccessListItem struct {

	// The IP address or CIDR range that you want to add to the cluster's IP access list.
	// Example: 8.8.8.8/32
	// Required: true
	Cidr *string `json:"cidr"`

	// Description that explains the purpose of the entry.
	// Example: My Current IP Address
	Description string `json:"description,omitempty"`
}

OpenapiIPAccessListItem openapi Ip access list item

swagger:model openapiIpAccessListItem

func (*OpenapiIPAccessListItem) ContextValidate 

func (m *OpenapiIPAccessListItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi Ip access list item based on context it is used

func (*OpenapiIPAccessListItem) MarshalBinary 

func (m *OpenapiIPAccessListItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiIPAccessListItem) UnmarshalBinary 

func (m *OpenapiIPAccessListItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiIPAccessListItem) Validate 

func (m *OpenapiIPAccessListItem) Validate(formats strfmt.Registry) error

Validate validates this openapi Ip access list item

type OpenapiImportItem 

type OpenapiImportItem struct {

	// metadata
	Metadata *OpenapiImportItemMetadata `json:"metadata,omitempty"`

	// spec
	Spec *OpenapiImportItemSpec `json:"spec,omitempty"`

	// status
	Status *OpenapiImportItemStatus `json:"status,omitempty"`
}

OpenapiImportItem ImportItem

ImportItem represents the information of a single import task.

swagger:model openapiImportItem

func (*OpenapiImportItem) ContextValidate 

func (m *OpenapiImportItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import item based on the context it is used

func (*OpenapiImportItem) MarshalBinary 

func (m *OpenapiImportItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItem) UnmarshalBinary 

func (m *OpenapiImportItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItem) Validate 

func (m *OpenapiImportItem) Validate(formats strfmt.Registry) error

Validate validates this openapi import item

type OpenapiImportItemMetadata 

type OpenapiImportItemMetadata struct {

	// The creation time of the import task in Unix timestamp seconds (epoch time).
	// Example: 1676450597
	// Required: true
	CreateTimestamp *string `json:"create_timestamp"`

	// The ID of the import task.
	// Example: 1
	// Required: true
	ID *string `json:"id"`

	// The name of the import task.
	// Example: my_import
	Name string `json:"name,omitempty"`
}

OpenapiImportItemMetadata ImportMetadata

The metadata of the import task.

swagger:model OpenapiImportItemMetadata

func (*OpenapiImportItemMetadata) ContextValidate 

func (m *OpenapiImportItemMetadata) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import item metadata based on context it is used

func (*OpenapiImportItemMetadata) MarshalBinary 

func (m *OpenapiImportItemMetadata) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemMetadata) UnmarshalBinary 

func (m *OpenapiImportItemMetadata) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemMetadata) Validate 

func (m *OpenapiImportItemMetadata) Validate(formats strfmt.Registry) error

Validate validates this openapi import item metadata

type OpenapiImportItemSpec 

type OpenapiImportItemSpec struct {

	// source
	// Required: true
	Source *OpenapiImportItemSpecSource `json:"source"`

	// target
	// Required: true
	Target *OpenapiImportItemSpecTarget `json:"target"`
}

OpenapiImportItemSpec ImportSpec

The specification of the import task.

swagger:model OpenapiImportItemSpec

func (*OpenapiImportItemSpec) ContextValidate 

func (m *OpenapiImportItemSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import item spec based on the context it is used

func (*OpenapiImportItemSpec) MarshalBinary 

func (m *OpenapiImportItemSpec) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpec) UnmarshalBinary 

func (m *OpenapiImportItemSpec) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpec) Validate 

func (m *OpenapiImportItemSpec) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec

type OpenapiImportItemSpecSource 

type OpenapiImportItemSpecSource struct {

	// aws assume role access
	AwsAssumeRoleAccess *OpenapiImportItemSpecSourceAwsAssumeRoleAccess `json:"aws_assume_role_access,omitempty"`

	// aws key access
	AwsKeyAccess *OpenapiImportItemSpecSourceAwsKeyAccess `json:"aws_key_access,omitempty"`

	// format
	// Required: true
	Format *OpenapiImportItemSpecSourceFormat `json:"format"`

	// The data source type of an import task.
	//
	// - `"S3"`: import data from Amazon S3
	// - `"GCS"`: import data from Google Cloud Storage
	// - `"LOCAL_FILE"`: import data from a local file (only available for [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters). Before you import from a local file, you need to first upload the file using the [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile) endpoint.
	//
	// **Note:** Currently, if this import spec is used for a [preview](#tag/Import/operation/PreviewImportData) request, only the `LOCAL_FILE` source type is supported.
	// Example: S3
	// Required: true
	// Enum: [S3 GCS LOCAL_FILE]
	Type *string `json:"type"`

	// The data source URI of an import task. The URI scheme must match the data source type. Here are the scheme of each source type:
	// * `S3`: `s3://`
	// * `GCS`: `gs://`
	// * `LOCAL_FILE`: `file://`.
	//
	// **Note:** If the import source type is `LOCAL_FILE`, just provide the `upload_stub_id` of the uploaded file from the response of [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile), and make it as the data source folder. For example: `file://12345/`.
	//
	// **Limitation**: If the import source type is `LOCAL_FILE`, only the `CSV` source format type is supported.
	// Example: s3://example-bucket/example-source-data/
	// Required: true
	URI *string `json:"uri"`
}

OpenapiImportItemSpecSource ImportSource

The data source settings of the import task.

swagger:model OpenapiImportItemSpecSource

func (*OpenapiImportItemSpecSource) ContextValidate 

func (m *OpenapiImportItemSpecSource) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import item spec source based on the context it is used

func (*OpenapiImportItemSpecSource) MarshalBinary 

func (m *OpenapiImportItemSpecSource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpecSource) UnmarshalBinary 

func (m *OpenapiImportItemSpecSource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpecSource) Validate 

func (m *OpenapiImportItemSpecSource) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec source

type OpenapiImportItemSpecSourceAwsAssumeRoleAccess 

type OpenapiImportItemSpecSourceAwsAssumeRoleAccess struct {

	// The specific AWS role ARN that needs to be assumed to access the Amazon S3 data source.
	// Example: arn:aws:iam::999999999999:role/sample-role
	// Required: true
	AssumeRole *string `json:"assume_role"`
}

OpenapiImportItemSpecSourceAwsAssumeRoleAccess AwsAssumeRoleAccess

The settings to access the S3 data by assuming a specific AWS role. This field is only needed if you need to access S3 data by assuming an AWS role.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiImportItemSpecSourceAwsAssumeRoleAccess

func (*OpenapiImportItemSpecSourceAwsAssumeRoleAccess) ContextValidate 

func (m *OpenapiImportItemSpecSourceAwsAssumeRoleAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import item spec source aws assume role access based on context it is used

func (*OpenapiImportItemSpecSourceAwsAssumeRoleAccess) MarshalBinary 

func (m *OpenapiImportItemSpecSourceAwsAssumeRoleAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceAwsAssumeRoleAccess) UnmarshalBinary 

func (m *OpenapiImportItemSpecSourceAwsAssumeRoleAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceAwsAssumeRoleAccess) Validate 

func (m *OpenapiImportItemSpecSourceAwsAssumeRoleAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec source aws assume role access

type OpenapiImportItemSpecSourceAwsKeyAccess 

type OpenapiImportItemSpecSourceAwsKeyAccess struct {

	// The access key ID of the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_ACCESS_KEY_ID
	// Required: true
	AccessKeyID *string `json:"access_key_id"`

	// The secret access key for the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_SECRET_ACCESS_KEY
	// Required: true
	SecretAccessKey *string `json:"secret_access_key"`
}

OpenapiImportItemSpecSourceAwsKeyAccess AwsKeyAccess

The settings to access the S3 data with an access key. This field is only needed if you want to access the S3 data with an access key.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiImportItemSpecSourceAwsKeyAccess

func (*OpenapiImportItemSpecSourceAwsKeyAccess) ContextValidate 

func (m *OpenapiImportItemSpecSourceAwsKeyAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import item spec source aws key access based on context it is used

func (*OpenapiImportItemSpecSourceAwsKeyAccess) MarshalBinary 

func (m *OpenapiImportItemSpecSourceAwsKeyAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceAwsKeyAccess) UnmarshalBinary 

func (m *OpenapiImportItemSpecSourceAwsKeyAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceAwsKeyAccess) Validate 

func (m *OpenapiImportItemSpecSourceAwsKeyAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec source aws key access

type OpenapiImportItemSpecSourceFormat 

type OpenapiImportItemSpecSourceFormat struct {

	// csv config
	CsvConfig *OpenapiImportItemSpecSourceFormatCsvConfig `json:"csv_config,omitempty"`

	// The format type of an import source.
	// Example: CSV
	// Required: true
	// Enum: [CSV PARQUET SQL AURORA_SNAPSHOT]
	Type *string `json:"type"`
}

OpenapiImportItemSpecSourceFormat ImportSourceFormat

The format settings of the import data source.

swagger:model OpenapiImportItemSpecSourceFormat

func (*OpenapiImportItemSpecSourceFormat) ContextValidate 

func (m *OpenapiImportItemSpecSourceFormat) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import item spec source format based on the context it is used

func (*OpenapiImportItemSpecSourceFormat) MarshalBinary 

func (m *OpenapiImportItemSpecSourceFormat) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceFormat) UnmarshalBinary 

func (m *OpenapiImportItemSpecSourceFormat) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceFormat) Validate 

func (m *OpenapiImportItemSpecSourceFormat) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec source format

type OpenapiImportItemSpecSourceFormatCsvConfig 

type OpenapiImportItemSpecSourceFormatCsvConfig struct {

	// Whether a backslash (`\`) symbol followed by a character should be combined as a whole and treated as an escape sequence in a CSV field. For example, if this parameter is set to `true`, `\n` will be treated as a 'new-line' character. If it is set to `false`, `\n` will be treated as two separate characters: backslash and `n`.
	//
	// Currently, these are several supported escape sequences: `\0`, `\b`, `\n`, `\r`, `\t`, and `\Z`. If the parameter is set to `true`, but the backslash escape sequence is not recognized, the backslash character is ignored.
	BackslashEscape *bool `json:"backslash_escape,omitempty"`

	// The delimiter character used to separate fields in the CSV data.
	Delimiter *string `json:"delimiter,omitempty"`

	// Whether the CSV data has a header row, which is not part of the data. If it is set to `true`, the import task will use the column names in the header row to match the column names in the target table.
	HasHeaderRow *bool `json:"has_header_row,omitempty"`

	// The character used to quote the fields in the CSV data.
	Quote *string `json:"quote,omitempty"`
}

OpenapiImportItemSpecSourceFormatCsvConfig ImportSourceCSVConfig

The CSV format settings to parse the source CSV files. This field is only needed if the source format is CSV.

swagger:model OpenapiImportItemSpecSourceFormatCsvConfig

func (*OpenapiImportItemSpecSourceFormatCsvConfig) ContextValidate 

func (m *OpenapiImportItemSpecSourceFormatCsvConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import item spec source format csv config based on context it is used

func (*OpenapiImportItemSpecSourceFormatCsvConfig) MarshalBinary 

func (m *OpenapiImportItemSpecSourceFormatCsvConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceFormatCsvConfig) UnmarshalBinary 

func (m *OpenapiImportItemSpecSourceFormatCsvConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpecSourceFormatCsvConfig) Validate 

func (m *OpenapiImportItemSpecSourceFormatCsvConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec source format csv config

type OpenapiImportItemSpecTarget 

type OpenapiImportItemSpecTarget struct {

	// The settings for each target table that is being imported for the import task. If you leave it empty, the system will scan all the files in the data source using the default file patterns and collect all the tables to import. The files include data files, table schema files, and DB schema files. If you provide a list of tables, only those tables will be imported. For more information about the default file pattern, see [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Limitations:**
	// * Currently, if you want to use a custom filename pattern, you can only specify one table. If all the tables use the default filename pattern, you can specify more than one target table in `tables`.
	// * It is recommended that you pre-create the target tables before creating an import task. You can do this either by executing the `CREATE TABLE` statement in the cluster or by specifying the table definition in the table creation options.
	// * If a target table is not created, the import module tries to find a **TABLE SCHEMA FILE** containing the `CREATE TABLE` statement of the table in the data source folder with the name `${db_name}.${table_name}-schema.sql` (for example, `db01.tbl01-schema.sql`). If this file is found, the `CREATE TABLE` statement is automatically executed if the table doesn't exist before the actual import process starts. If the table is still missing after this pre-create step, an error will occur.
	Tables []*OpenapiImportItemSpecTargetTablesItems0 `json:"tables"`
}

OpenapiImportItemSpecTarget ImportTarget

The target settings of the import task.

swagger:model OpenapiImportItemSpecTarget

func (*OpenapiImportItemSpecTarget) ContextValidate 

func (m *OpenapiImportItemSpecTarget) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import item spec target based on the context it is used

func (*OpenapiImportItemSpecTarget) MarshalBinary 

func (m *OpenapiImportItemSpecTarget) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpecTarget) UnmarshalBinary 

func (m *OpenapiImportItemSpecTarget) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpecTarget) Validate 

func (m *OpenapiImportItemSpecTarget) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec target

type OpenapiImportItemSpecTargetTablesItems0 

type OpenapiImportItemSpecTargetTablesItems0 struct {

	// The target database name.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// The filename pattern used to map the files in the data source to this target table. The pattern should be a simple glob pattern. Here are some examples:
	// * `my-data?.csv`: all CSV files starting with `my-data` and one character (such as `my-data1.csv` and `my-data2.csv`) will be imported into the same target table.
	// * `my-data*.csv`: all CSV files starting with `my-data` will be imported into the same target table.
	//
	// If no pattern is specified, a default pattern is used. The default pattern will try to find files with this naming convention as the data files for this table: `${db_name}.${table_name}.[numeric_index].${format_suffix}`.
	//
	// Here are some examples of filenames that can be matched as data files for the table `db01.table01`: `db01.table01.csv`, `db01.table01.00001.csv`.
	//
	// For more information about the custom file pattern and the default pattern, refer to [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Note:** For `LOCAL_FILE` import tasks, use the local file name for this field. The local file name must match the local file name in [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile).
	// Example: data/db01/table01.*.csv
	FileNamePattern string `json:"file_name_pattern,omitempty"`

	// The target table name.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiImportItemSpecTargetTablesItems0 ImportTargetTable

ImportTargetTable represents the settings for importing source data into a single target table of an import task.

swagger:model OpenapiImportItemSpecTargetTablesItems0

func (*OpenapiImportItemSpecTargetTablesItems0) ContextValidate 

func (m *OpenapiImportItemSpecTargetTablesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import item spec target tables items0 based on context it is used

func (*OpenapiImportItemSpecTargetTablesItems0) MarshalBinary 

func (m *OpenapiImportItemSpecTargetTablesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemSpecTargetTablesItems0) UnmarshalBinary 

func (m *OpenapiImportItemSpecTargetTablesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemSpecTargetTablesItems0) Validate 

func (m *OpenapiImportItemSpecTargetTablesItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi import item spec target tables items0

type OpenapiImportItemStatus 

type OpenapiImportItemStatus struct {

	// The end timestamp of the import task. The format is Unix timestamp (the seconds elapsed since the Unix epoch).
	// Example: 1676450897
	EndTimestamp string `json:"end_timestamp,omitempty"`

	// The error message of the import task.
	// Example: some error occurs
	ErrorMessage string `json:"error_message,omitempty"`

	// The current phase that the import task is in.
	// Example: IMPORTING
	// Required: true
	// Enum: [PREPARING IMPORTING COMPLETED FAILED CANCELING CANCELED]
	Phase *string `json:"phase"`

	// progress
	Progress *OpenapiImportItemStatusProgress `json:"progress,omitempty"`

	// The total size of the import task's data source. The unit is bytes.
	// Example: 10737418240
	SourceTotalSizeBytes string `json:"source_total_size_bytes,omitempty"`

	// The start timestamp of the import task. The format is Unix timestamp (the seconds elapsed since the Unix epoch)
	// Example: 1676450597
	StartTimestamp string `json:"start_timestamp,omitempty"`
}

OpenapiImportItemStatus ImportStatus

The status of the import task.

swagger:model OpenapiImportItemStatus

func (*OpenapiImportItemStatus) ContextValidate 

func (m *OpenapiImportItemStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import item status based on the context it is used

func (*OpenapiImportItemStatus) MarshalBinary 

func (m *OpenapiImportItemStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemStatus) UnmarshalBinary 

func (m *OpenapiImportItemStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemStatus) Validate 

func (m *OpenapiImportItemStatus) Validate(formats strfmt.Registry) error

Validate validates this openapi import item status

type OpenapiImportItemStatusProgress 

type OpenapiImportItemStatusProgress struct {

	// The overall importing progress of the import task.
	// Example: 59
	// Required: true
	// Maximum: 100
	ImportProgress *float64 `json:"import_progress"`

	// The overall validation progress of the import task after the data has been imported into the target cluster.
	// Example: 59
	// Required: true
	// Maximum: 100
	ValidationProgress *float64 `json:"validation_progress"`
}

OpenapiImportItemStatusProgress ImportProgress

The progress of the import task.

swagger:model OpenapiImportItemStatusProgress

func (*OpenapiImportItemStatusProgress) ContextValidate 

func (m *OpenapiImportItemStatusProgress) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import item status progress based on context it is used

func (*OpenapiImportItemStatusProgress) MarshalBinary 

func (m *OpenapiImportItemStatusProgress) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportItemStatusProgress) UnmarshalBinary 

func (m *OpenapiImportItemStatusProgress) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportItemStatusProgress) Validate 

func (m *OpenapiImportItemStatusProgress) Validate(formats strfmt.Registry) error

Validate validates this openapi import item status progress

type OpenapiImportMetadata 

type OpenapiImportMetadata struct {

	// The creation time of the import task in Unix timestamp seconds (epoch time).
	// Example: 1676450597
	// Required: true
	CreateTimestamp *string `json:"create_timestamp"`

	// The ID of the import task.
	// Example: 1
	// Required: true
	ID *string `json:"id"`

	// The name of the import task.
	// Example: my_import
	Name string `json:"name,omitempty"`
}

OpenapiImportMetadata ImportMetadata

ImportMetadata represents some basic metadata about an import task.

swagger:model openapiImportMetadata

func (*OpenapiImportMetadata) ContextValidate 

func (m *OpenapiImportMetadata) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import metadata based on context it is used

func (*OpenapiImportMetadata) MarshalBinary 

func (m *OpenapiImportMetadata) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportMetadata) UnmarshalBinary 

func (m *OpenapiImportMetadata) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportMetadata) Validate 

func (m *OpenapiImportMetadata) Validate(formats strfmt.Registry) error

Validate validates this openapi import metadata

type OpenapiImportProgress 

type OpenapiImportProgress struct {

	// The overall importing progress of the import task.
	// Example: 59
	// Required: true
	// Maximum: 100
	ImportProgress *float64 `json:"import_progress"`

	// The overall validation progress of the import task after the data has been imported into the target cluster.
	// Example: 59
	// Required: true
	// Maximum: 100
	ValidationProgress *float64 `json:"validation_progress"`
}

OpenapiImportProgress ImportProgress

ImportProgress represents the progress information of an import task.

swagger:model openapiImportProgress

func (*OpenapiImportProgress) ContextValidate 

func (m *OpenapiImportProgress) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import progress based on context it is used

func (*OpenapiImportProgress) MarshalBinary 

func (m *OpenapiImportProgress) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportProgress) UnmarshalBinary 

func (m *OpenapiImportProgress) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportProgress) Validate 

func (m *OpenapiImportProgress) Validate(formats strfmt.Registry) error

Validate validates this openapi import progress

type OpenapiImportSource 

type OpenapiImportSource struct {

	// aws assume role access
	AwsAssumeRoleAccess *OpenapiImportSourceAwsAssumeRoleAccess `json:"aws_assume_role_access,omitempty"`

	// aws key access
	AwsKeyAccess *OpenapiImportSourceAwsKeyAccess `json:"aws_key_access,omitempty"`

	// format
	// Required: true
	Format *OpenapiImportSourceFormat `json:"format"`

	// The data source type of an import task.
	//
	// - `"S3"`: import data from Amazon S3
	// - `"GCS"`: import data from Google Cloud Storage
	// - `"LOCAL_FILE"`: import data from a local file (only available for [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters). Before you import from a local file, you need to first upload the file using the [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile) endpoint.
	//
	// **Note:** Currently, if this import spec is used for a [preview](#tag/Import/operation/PreviewImportData) request, only the `LOCAL_FILE` source type is supported.
	// Example: S3
	// Required: true
	// Enum: [S3 GCS LOCAL_FILE]
	Type *string `json:"type"`

	// The data source URI of an import task. The URI scheme must match the data source type. Here are the scheme of each source type:
	// * `S3`: `s3://`
	// * `GCS`: `gs://`
	// * `LOCAL_FILE`: `file://`.
	//
	// **Note:** If the import source type is `LOCAL_FILE`, just provide the `upload_stub_id` of the uploaded file from the response of [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile), and make it as the data source folder. For example: `file://12345/`.
	//
	// **Limitation**: If the import source type is `LOCAL_FILE`, only the `CSV` source format type is supported.
	// Example: s3://example-bucket/example-source-data/
	// Required: true
	URI *string `json:"uri"`
}

OpenapiImportSource ImportSource

ImportSource represents the data source settings of an import task.

swagger:model openapiImportSource

func (*OpenapiImportSource) ContextValidate 

func (m *OpenapiImportSource) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import source based on the context it is used

func (*OpenapiImportSource) MarshalBinary 

func (m *OpenapiImportSource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSource) UnmarshalBinary 

func (m *OpenapiImportSource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSource) Validate 

func (m *OpenapiImportSource) Validate(formats strfmt.Registry) error

Validate validates this openapi import source

type OpenapiImportSourceAwsAssumeRoleAccess 

type OpenapiImportSourceAwsAssumeRoleAccess struct {

	// The specific AWS role ARN that needs to be assumed to access the Amazon S3 data source.
	// Example: arn:aws:iam::999999999999:role/sample-role
	// Required: true
	AssumeRole *string `json:"assume_role"`
}

OpenapiImportSourceAwsAssumeRoleAccess AwsAssumeRoleAccess

The settings to access the S3 data by assuming a specific AWS role. This field is only needed if you need to access S3 data by assuming an AWS role.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiImportSourceAwsAssumeRoleAccess

func (*OpenapiImportSourceAwsAssumeRoleAccess) ContextValidate 

func (m *OpenapiImportSourceAwsAssumeRoleAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import source aws assume role access based on context it is used

func (*OpenapiImportSourceAwsAssumeRoleAccess) MarshalBinary 

func (m *OpenapiImportSourceAwsAssumeRoleAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSourceAwsAssumeRoleAccess) UnmarshalBinary 

func (m *OpenapiImportSourceAwsAssumeRoleAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSourceAwsAssumeRoleAccess) Validate 

func (m *OpenapiImportSourceAwsAssumeRoleAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi import source aws assume role access

type OpenapiImportSourceAwsKeyAccess 

type OpenapiImportSourceAwsKeyAccess struct {

	// The access key ID of the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_ACCESS_KEY_ID
	// Required: true
	AccessKeyID *string `json:"access_key_id"`

	// The secret access key for the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_SECRET_ACCESS_KEY
	// Required: true
	SecretAccessKey *string `json:"secret_access_key"`
}

OpenapiImportSourceAwsKeyAccess AwsKeyAccess

The settings to access the S3 data with an access key. This field is only needed if you want to access the S3 data with an access key.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiImportSourceAwsKeyAccess

func (*OpenapiImportSourceAwsKeyAccess) ContextValidate 

func (m *OpenapiImportSourceAwsKeyAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import source aws key access based on context it is used

func (*OpenapiImportSourceAwsKeyAccess) MarshalBinary 

func (m *OpenapiImportSourceAwsKeyAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSourceAwsKeyAccess) UnmarshalBinary 

func (m *OpenapiImportSourceAwsKeyAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSourceAwsKeyAccess) Validate 

func (m *OpenapiImportSourceAwsKeyAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi import source aws key access

type OpenapiImportSourceCSVConfig 

type OpenapiImportSourceCSVConfig struct {

	// Whether a backslash (`\`) symbol followed by a character should be combined as a whole and treated as an escape sequence in a CSV field. For example, if this parameter is set to `true`, `\n` will be treated as a 'new-line' character. If it is set to `false`, `\n` will be treated as two separate characters: backslash and `n`.
	//
	// Currently, these are several supported escape sequences: `\0`, `\b`, `\n`, `\r`, `\t`, and `\Z`. If the parameter is set to `true`, but the backslash escape sequence is not recognized, the backslash character is ignored.
	BackslashEscape *bool `json:"backslash_escape,omitempty"`

	// The delimiter character used to separate fields in the CSV data.
	Delimiter *string `json:"delimiter,omitempty"`

	// Whether the CSV data has a header row, which is not part of the data. If it is set to `true`, the import task will use the column names in the header row to match the column names in the target table.
	HasHeaderRow *bool `json:"has_header_row,omitempty"`

	// The character used to quote the fields in the CSV data.
	Quote *string `json:"quote,omitempty"`
}

OpenapiImportSourceCSVConfig ImportSourceCSVConfig

ImportSourceCSVConfig represents the settings for parsing the CSV source data of an import task.

swagger:model openapiImportSourceCSVConfig

func (*OpenapiImportSourceCSVConfig) ContextValidate 

func (m *OpenapiImportSourceCSVConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import source c s v config based on context it is used

func (*OpenapiImportSourceCSVConfig) MarshalBinary 

func (m *OpenapiImportSourceCSVConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSourceCSVConfig) UnmarshalBinary 

func (m *OpenapiImportSourceCSVConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSourceCSVConfig) Validate 

func (m *OpenapiImportSourceCSVConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi import source c s v config

type OpenapiImportSourceFormat 

type OpenapiImportSourceFormat struct {

	// csv config
	CsvConfig *OpenapiImportSourceFormatCsvConfig `json:"csv_config,omitempty"`

	// The format type of an import source.
	// Example: CSV
	// Required: true
	// Enum: [CSV PARQUET SQL AURORA_SNAPSHOT]
	Type *string `json:"type"`
}

OpenapiImportSourceFormat ImportSourceFormat

ImportSourceFormat represents the settings for reading and parsing source data in the correct format.

swagger:model openapiImportSourceFormat

func (*OpenapiImportSourceFormat) ContextValidate 

func (m *OpenapiImportSourceFormat) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import source format based on the context it is used

func (*OpenapiImportSourceFormat) MarshalBinary 

func (m *OpenapiImportSourceFormat) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSourceFormat) UnmarshalBinary 

func (m *OpenapiImportSourceFormat) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSourceFormat) Validate 

func (m *OpenapiImportSourceFormat) Validate(formats strfmt.Registry) error

Validate validates this openapi import source format

type OpenapiImportSourceFormatCsvConfig 

type OpenapiImportSourceFormatCsvConfig struct {

	// Whether a backslash (`\`) symbol followed by a character should be combined as a whole and treated as an escape sequence in a CSV field. For example, if this parameter is set to `true`, `\n` will be treated as a 'new-line' character. If it is set to `false`, `\n` will be treated as two separate characters: backslash and `n`.
	//
	// Currently, these are several supported escape sequences: `\0`, `\b`, `\n`, `\r`, `\t`, and `\Z`. If the parameter is set to `true`, but the backslash escape sequence is not recognized, the backslash character is ignored.
	BackslashEscape *bool `json:"backslash_escape,omitempty"`

	// The delimiter character used to separate fields in the CSV data.
	Delimiter *string `json:"delimiter,omitempty"`

	// Whether the CSV data has a header row, which is not part of the data. If it is set to `true`, the import task will use the column names in the header row to match the column names in the target table.
	HasHeaderRow *bool `json:"has_header_row,omitempty"`

	// The character used to quote the fields in the CSV data.
	Quote *string `json:"quote,omitempty"`
}

OpenapiImportSourceFormatCsvConfig ImportSourceCSVConfig

The CSV format settings to parse the source CSV files. This field is only needed if the source format is CSV.

swagger:model OpenapiImportSourceFormatCsvConfig

func (*OpenapiImportSourceFormatCsvConfig) ContextValidate 

func (m *OpenapiImportSourceFormatCsvConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import source format csv config based on context it is used

func (*OpenapiImportSourceFormatCsvConfig) MarshalBinary 

func (m *OpenapiImportSourceFormatCsvConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSourceFormatCsvConfig) UnmarshalBinary 

func (m *OpenapiImportSourceFormatCsvConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSourceFormatCsvConfig) Validate 

func (m *OpenapiImportSourceFormatCsvConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi import source format csv config

type OpenapiImportSpec 

type OpenapiImportSpec struct {

	// source
	// Required: true
	Source *OpenapiImportSpecSource `json:"source"`

	// target
	// Required: true
	Target *OpenapiImportSpecTarget `json:"target"`
}

OpenapiImportSpec ImportSpec

ImportSpec represents the settings and specifications of an import task.

swagger:model openapiImportSpec

func (*OpenapiImportSpec) ContextValidate 

func (m *OpenapiImportSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import spec based on the context it is used

func (*OpenapiImportSpec) MarshalBinary 

func (m *OpenapiImportSpec) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpec) UnmarshalBinary 

func (m *OpenapiImportSpec) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpec) Validate 

func (m *OpenapiImportSpec) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec

type OpenapiImportSpecSource 

type OpenapiImportSpecSource struct {

	// aws assume role access
	AwsAssumeRoleAccess *OpenapiImportSpecSourceAwsAssumeRoleAccess `json:"aws_assume_role_access,omitempty"`

	// aws key access
	AwsKeyAccess *OpenapiImportSpecSourceAwsKeyAccess `json:"aws_key_access,omitempty"`

	// format
	// Required: true
	Format *OpenapiImportSpecSourceFormat `json:"format"`

	// The data source type of an import task.
	//
	// - `"S3"`: import data from Amazon S3
	// - `"GCS"`: import data from Google Cloud Storage
	// - `"LOCAL_FILE"`: import data from a local file (only available for [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters). Before you import from a local file, you need to first upload the file using the [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile) endpoint.
	//
	// **Note:** Currently, if this import spec is used for a [preview](#tag/Import/operation/PreviewImportData) request, only the `LOCAL_FILE` source type is supported.
	// Example: S3
	// Required: true
	// Enum: [S3 GCS LOCAL_FILE]
	Type *string `json:"type"`

	// The data source URI of an import task. The URI scheme must match the data source type. Here are the scheme of each source type:
	// * `S3`: `s3://`
	// * `GCS`: `gs://`
	// * `LOCAL_FILE`: `file://`.
	//
	// **Note:** If the import source type is `LOCAL_FILE`, just provide the `upload_stub_id` of the uploaded file from the response of [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile), and make it as the data source folder. For example: `file://12345/`.
	//
	// **Limitation**: If the import source type is `LOCAL_FILE`, only the `CSV` source format type is supported.
	// Example: s3://example-bucket/example-source-data/
	// Required: true
	URI *string `json:"uri"`
}

OpenapiImportSpecSource ImportSource

The data source settings of the import task.

swagger:model OpenapiImportSpecSource

func (*OpenapiImportSpecSource) ContextValidate 

func (m *OpenapiImportSpecSource) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import spec source based on the context it is used

func (*OpenapiImportSpecSource) MarshalBinary 

func (m *OpenapiImportSpecSource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpecSource) UnmarshalBinary 

func (m *OpenapiImportSpecSource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpecSource) Validate 

func (m *OpenapiImportSpecSource) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec source

type OpenapiImportSpecSourceAwsAssumeRoleAccess 

type OpenapiImportSpecSourceAwsAssumeRoleAccess struct {

	// The specific AWS role ARN that needs to be assumed to access the Amazon S3 data source.
	// Example: arn:aws:iam::999999999999:role/sample-role
	// Required: true
	AssumeRole *string `json:"assume_role"`
}

OpenapiImportSpecSourceAwsAssumeRoleAccess AwsAssumeRoleAccess

The settings to access the S3 data by assuming a specific AWS role. This field is only needed if you need to access S3 data by assuming an AWS role.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiImportSpecSourceAwsAssumeRoleAccess

func (*OpenapiImportSpecSourceAwsAssumeRoleAccess) ContextValidate 

func (m *OpenapiImportSpecSourceAwsAssumeRoleAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import spec source aws assume role access based on context it is used

func (*OpenapiImportSpecSourceAwsAssumeRoleAccess) MarshalBinary 

func (m *OpenapiImportSpecSourceAwsAssumeRoleAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpecSourceAwsAssumeRoleAccess) UnmarshalBinary 

func (m *OpenapiImportSpecSourceAwsAssumeRoleAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpecSourceAwsAssumeRoleAccess) Validate 

func (m *OpenapiImportSpecSourceAwsAssumeRoleAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec source aws assume role access

type OpenapiImportSpecSourceAwsKeyAccess 

type OpenapiImportSpecSourceAwsKeyAccess struct {

	// The access key ID of the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_ACCESS_KEY_ID
	// Required: true
	AccessKeyID *string `json:"access_key_id"`

	// The secret access key for the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_SECRET_ACCESS_KEY
	// Required: true
	SecretAccessKey *string `json:"secret_access_key"`
}

OpenapiImportSpecSourceAwsKeyAccess AwsKeyAccess

The settings to access the S3 data with an access key. This field is only needed if you want to access the S3 data with an access key.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiImportSpecSourceAwsKeyAccess

func (*OpenapiImportSpecSourceAwsKeyAccess) ContextValidate 

func (m *OpenapiImportSpecSourceAwsKeyAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import spec source aws key access based on context it is used

func (*OpenapiImportSpecSourceAwsKeyAccess) MarshalBinary 

func (m *OpenapiImportSpecSourceAwsKeyAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpecSourceAwsKeyAccess) UnmarshalBinary 

func (m *OpenapiImportSpecSourceAwsKeyAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpecSourceAwsKeyAccess) Validate 

func (m *OpenapiImportSpecSourceAwsKeyAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec source aws key access

type OpenapiImportSpecSourceFormat 

type OpenapiImportSpecSourceFormat struct {

	// csv config
	CsvConfig *OpenapiImportSpecSourceFormatCsvConfig `json:"csv_config,omitempty"`

	// The format type of an import source.
	// Example: CSV
	// Required: true
	// Enum: [CSV PARQUET SQL AURORA_SNAPSHOT]
	Type *string `json:"type"`
}

OpenapiImportSpecSourceFormat ImportSourceFormat

The format settings of the import data source.

swagger:model OpenapiImportSpecSourceFormat

func (*OpenapiImportSpecSourceFormat) ContextValidate 

func (m *OpenapiImportSpecSourceFormat) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import spec source format based on the context it is used

func (*OpenapiImportSpecSourceFormat) MarshalBinary 

func (m *OpenapiImportSpecSourceFormat) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpecSourceFormat) UnmarshalBinary 

func (m *OpenapiImportSpecSourceFormat) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpecSourceFormat) Validate 

func (m *OpenapiImportSpecSourceFormat) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec source format

type OpenapiImportSpecSourceFormatCsvConfig 

type OpenapiImportSpecSourceFormatCsvConfig struct {

	// Whether a backslash (`\`) symbol followed by a character should be combined as a whole and treated as an escape sequence in a CSV field. For example, if this parameter is set to `true`, `\n` will be treated as a 'new-line' character. If it is set to `false`, `\n` will be treated as two separate characters: backslash and `n`.
	//
	// Currently, these are several supported escape sequences: `\0`, `\b`, `\n`, `\r`, `\t`, and `\Z`. If the parameter is set to `true`, but the backslash escape sequence is not recognized, the backslash character is ignored.
	BackslashEscape *bool `json:"backslash_escape,omitempty"`

	// The delimiter character used to separate fields in the CSV data.
	Delimiter *string `json:"delimiter,omitempty"`

	// Whether the CSV data has a header row, which is not part of the data. If it is set to `true`, the import task will use the column names in the header row to match the column names in the target table.
	HasHeaderRow *bool `json:"has_header_row,omitempty"`

	// The character used to quote the fields in the CSV data.
	Quote *string `json:"quote,omitempty"`
}

OpenapiImportSpecSourceFormatCsvConfig ImportSourceCSVConfig

The CSV format settings to parse the source CSV files. This field is only needed if the source format is CSV.

swagger:model OpenapiImportSpecSourceFormatCsvConfig

func (*OpenapiImportSpecSourceFormatCsvConfig) ContextValidate 

func (m *OpenapiImportSpecSourceFormatCsvConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import spec source format csv config based on context it is used

func (*OpenapiImportSpecSourceFormatCsvConfig) MarshalBinary 

func (m *OpenapiImportSpecSourceFormatCsvConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpecSourceFormatCsvConfig) UnmarshalBinary 

func (m *OpenapiImportSpecSourceFormatCsvConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpecSourceFormatCsvConfig) Validate 

func (m *OpenapiImportSpecSourceFormatCsvConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec source format csv config

type OpenapiImportSpecTarget 

type OpenapiImportSpecTarget struct {

	// The settings for each target table that is being imported for the import task. If you leave it empty, the system will scan all the files in the data source using the default file patterns and collect all the tables to import. The files include data files, table schema files, and DB schema files. If you provide a list of tables, only those tables will be imported. For more information about the default file pattern, see [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Limitations:**
	// * Currently, if you want to use a custom filename pattern, you can only specify one table. If all the tables use the default filename pattern, you can specify more than one target table in `tables`.
	// * It is recommended that you pre-create the target tables before creating an import task. You can do this either by executing the `CREATE TABLE` statement in the cluster or by specifying the table definition in the table creation options.
	// * If a target table is not created, the import module tries to find a **TABLE SCHEMA FILE** containing the `CREATE TABLE` statement of the table in the data source folder with the name `${db_name}.${table_name}-schema.sql` (for example, `db01.tbl01-schema.sql`). If this file is found, the `CREATE TABLE` statement is automatically executed if the table doesn't exist before the actual import process starts. If the table is still missing after this pre-create step, an error will occur.
	Tables []*OpenapiImportSpecTargetTablesItems0 `json:"tables"`
}

OpenapiImportSpecTarget ImportTarget

The target settings of the import task.

swagger:model OpenapiImportSpecTarget

func (*OpenapiImportSpecTarget) ContextValidate 

func (m *OpenapiImportSpecTarget) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import spec target based on the context it is used

func (*OpenapiImportSpecTarget) MarshalBinary 

func (m *OpenapiImportSpecTarget) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpecTarget) UnmarshalBinary 

func (m *OpenapiImportSpecTarget) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpecTarget) Validate 

func (m *OpenapiImportSpecTarget) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec target

type OpenapiImportSpecTargetTablesItems0 

type OpenapiImportSpecTargetTablesItems0 struct {

	// The target database name.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// The filename pattern used to map the files in the data source to this target table. The pattern should be a simple glob pattern. Here are some examples:
	// * `my-data?.csv`: all CSV files starting with `my-data` and one character (such as `my-data1.csv` and `my-data2.csv`) will be imported into the same target table.
	// * `my-data*.csv`: all CSV files starting with `my-data` will be imported into the same target table.
	//
	// If no pattern is specified, a default pattern is used. The default pattern will try to find files with this naming convention as the data files for this table: `${db_name}.${table_name}.[numeric_index].${format_suffix}`.
	//
	// Here are some examples of filenames that can be matched as data files for the table `db01.table01`: `db01.table01.csv`, `db01.table01.00001.csv`.
	//
	// For more information about the custom file pattern and the default pattern, refer to [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Note:** For `LOCAL_FILE` import tasks, use the local file name for this field. The local file name must match the local file name in [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile).
	// Example: data/db01/table01.*.csv
	FileNamePattern string `json:"file_name_pattern,omitempty"`

	// The target table name.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiImportSpecTargetTablesItems0 ImportTargetTable

ImportTargetTable represents the settings for importing source data into a single target table of an import task.

swagger:model OpenapiImportSpecTargetTablesItems0

func (*OpenapiImportSpecTargetTablesItems0) ContextValidate 

func (m *OpenapiImportSpecTargetTablesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import spec target tables items0 based on context it is used

func (*OpenapiImportSpecTargetTablesItems0) MarshalBinary 

func (m *OpenapiImportSpecTargetTablesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportSpecTargetTablesItems0) UnmarshalBinary 

func (m *OpenapiImportSpecTargetTablesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportSpecTargetTablesItems0) Validate 

func (m *OpenapiImportSpecTargetTablesItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi import spec target tables items0

type OpenapiImportStatus 

type OpenapiImportStatus struct {

	// The end timestamp of the import task. The format is Unix timestamp (the seconds elapsed since the Unix epoch).
	// Example: 1676450897
	EndTimestamp string `json:"end_timestamp,omitempty"`

	// The error message of the import task.
	// Example: some error occurs
	ErrorMessage string `json:"error_message,omitempty"`

	// The current phase that the import task is in.
	// Example: IMPORTING
	// Required: true
	// Enum: [PREPARING IMPORTING COMPLETED FAILED CANCELING CANCELED]
	Phase *string `json:"phase"`

	// progress
	Progress *OpenapiImportStatusProgress `json:"progress,omitempty"`

	// The total size of the import task's data source. The unit is bytes.
	// Example: 10737418240
	SourceTotalSizeBytes string `json:"source_total_size_bytes,omitempty"`

	// The start timestamp of the import task. The format is Unix timestamp (the seconds elapsed since the Unix epoch)
	// Example: 1676450597
	StartTimestamp string `json:"start_timestamp,omitempty"`
}

OpenapiImportStatus ImportStatus

ImportStatus represents the status of an import task.

swagger:model openapiImportStatus

func (*OpenapiImportStatus) ContextValidate 

func (m *OpenapiImportStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import status based on the context it is used

func (*OpenapiImportStatus) MarshalBinary 

func (m *OpenapiImportStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportStatus) UnmarshalBinary 

func (m *OpenapiImportStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportStatus) Validate 

func (m *OpenapiImportStatus) Validate(formats strfmt.Registry) error

Validate validates this openapi import status

type OpenapiImportStatusProgress 

type OpenapiImportStatusProgress struct {

	// The overall importing progress of the import task.
	// Example: 59
	// Required: true
	// Maximum: 100
	ImportProgress *float64 `json:"import_progress"`

	// The overall validation progress of the import task after the data has been imported into the target cluster.
	// Example: 59
	// Required: true
	// Maximum: 100
	ValidationProgress *float64 `json:"validation_progress"`
}

OpenapiImportStatusProgress ImportProgress

The progress of the import task.

swagger:model OpenapiImportStatusProgress

func (*OpenapiImportStatusProgress) ContextValidate 

func (m *OpenapiImportStatusProgress) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import status progress based on context it is used

func (*OpenapiImportStatusProgress) MarshalBinary 

func (m *OpenapiImportStatusProgress) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportStatusProgress) UnmarshalBinary 

func (m *OpenapiImportStatusProgress) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportStatusProgress) Validate 

func (m *OpenapiImportStatusProgress) Validate(formats strfmt.Registry) error

Validate validates this openapi import status progress

type OpenapiImportTarget 

type OpenapiImportTarget struct {

	// The settings for each target table that is being imported for the import task. If you leave it empty, the system will scan all the files in the data source using the default file patterns and collect all the tables to import. The files include data files, table schema files, and DB schema files. If you provide a list of tables, only those tables will be imported. For more information about the default file pattern, see [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Limitations:**
	// * Currently, if you want to use a custom filename pattern, you can only specify one table. If all the tables use the default filename pattern, you can specify more than one target table in `tables`.
	// * It is recommended that you pre-create the target tables before creating an import task. You can do this either by executing the `CREATE TABLE` statement in the cluster or by specifying the table definition in the table creation options.
	// * If a target table is not created, the import module tries to find a **TABLE SCHEMA FILE** containing the `CREATE TABLE` statement of the table in the data source folder with the name `${db_name}.${table_name}-schema.sql` (for example, `db01.tbl01-schema.sql`). If this file is found, the `CREATE TABLE` statement is automatically executed if the table doesn't exist before the actual import process starts. If the table is still missing after this pre-create step, an error will occur.
	Tables []*OpenapiImportTargetTablesItems0 `json:"tables"`
}

OpenapiImportTarget ImportTarget

ImportTarget represents the target settings of an import task.

swagger:model openapiImportTarget

func (*OpenapiImportTarget) ContextValidate 

func (m *OpenapiImportTarget) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import target based on the context it is used

func (*OpenapiImportTarget) MarshalBinary 

func (m *OpenapiImportTarget) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportTarget) UnmarshalBinary 

func (m *OpenapiImportTarget) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportTarget) Validate 

func (m *OpenapiImportTarget) Validate(formats strfmt.Registry) error

Validate validates this openapi import target

type OpenapiImportTargetTable 

type OpenapiImportTargetTable struct {

	// The target database name.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// The filename pattern used to map the files in the data source to this target table. The pattern should be a simple glob pattern. Here are some examples:
	// * `my-data?.csv`: all CSV files starting with `my-data` and one character (such as `my-data1.csv` and `my-data2.csv`) will be imported into the same target table.
	// * `my-data*.csv`: all CSV files starting with `my-data` will be imported into the same target table.
	//
	// If no pattern is specified, a default pattern is used. The default pattern will try to find files with this naming convention as the data files for this table: `${db_name}.${table_name}.[numeric_index].${format_suffix}`.
	//
	// Here are some examples of filenames that can be matched as data files for the table `db01.table01`: `db01.table01.csv`, `db01.table01.00001.csv`.
	//
	// For more information about the custom file pattern and the default pattern, refer to [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Note:** For `LOCAL_FILE` import tasks, use the local file name for this field. The local file name must match the local file name in [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile).
	// Example: data/db01/table01.*.csv
	FileNamePattern string `json:"file_name_pattern,omitempty"`

	// The target table name.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiImportTargetTable ImportTargetTable

ImportTargetTable represents the settings for importing source data into a single target table of an import task.

swagger:model openapiImportTargetTable

func (*OpenapiImportTargetTable) ContextValidate 

func (m *OpenapiImportTargetTable) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import target table based on context it is used

func (*OpenapiImportTargetTable) MarshalBinary 

func (m *OpenapiImportTargetTable) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportTargetTable) UnmarshalBinary 

func (m *OpenapiImportTargetTable) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportTargetTable) Validate 

func (m *OpenapiImportTargetTable) Validate(formats strfmt.Registry) error

Validate validates this openapi import target table

type OpenapiImportTargetTablesItems0 

type OpenapiImportTargetTablesItems0 struct {

	// The target database name.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// The filename pattern used to map the files in the data source to this target table. The pattern should be a simple glob pattern. Here are some examples:
	// * `my-data?.csv`: all CSV files starting with `my-data` and one character (such as `my-data1.csv` and `my-data2.csv`) will be imported into the same target table.
	// * `my-data*.csv`: all CSV files starting with `my-data` will be imported into the same target table.
	//
	// If no pattern is specified, a default pattern is used. The default pattern will try to find files with this naming convention as the data files for this table: `${db_name}.${table_name}.[numeric_index].${format_suffix}`.
	//
	// Here are some examples of filenames that can be matched as data files for the table `db01.table01`: `db01.table01.csv`, `db01.table01.00001.csv`.
	//
	// For more information about the custom file pattern and the default pattern, refer to [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Note:** For `LOCAL_FILE` import tasks, use the local file name for this field. The local file name must match the local file name in [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile).
	// Example: data/db01/table01.*.csv
	FileNamePattern string `json:"file_name_pattern,omitempty"`

	// The target table name.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiImportTargetTablesItems0 ImportTargetTable

ImportTargetTable represents the settings for importing source data into a single target table of an import task.

swagger:model OpenapiImportTargetTablesItems0

func (*OpenapiImportTargetTablesItems0) ContextValidate 

func (m *OpenapiImportTargetTablesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import target tables items0 based on context it is used

func (*OpenapiImportTargetTablesItems0) MarshalBinary 

func (m *OpenapiImportTargetTablesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportTargetTablesItems0) UnmarshalBinary 

func (m *OpenapiImportTargetTablesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportTargetTablesItems0) Validate 

func (m *OpenapiImportTargetTablesItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi import target tables items0

type OpenapiImportTaskRoleInfo 

type OpenapiImportTaskRoleInfo struct {

	// aws import role
	AwsImportRole *OpenapiImportTaskRoleInfoAwsImportRole `json:"aws_import_role,omitempty"`

	// gcp import role
	GcpImportRole *OpenapiImportTaskRoleInfoGcpImportRole `json:"gcp_import_role,omitempty"`
}

OpenapiImportTaskRoleInfo ImportTaskRoleInfo

ImportTaskRoleInfo is the role information for import tasks on a cluster. You can use this information to configure the access for the import tasks to retrieve the data from the data source.

swagger:model openapiImportTaskRoleInfo

func (*OpenapiImportTaskRoleInfo) ContextValidate 

func (m *OpenapiImportTaskRoleInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi import task role info based on the context it is used

func (*OpenapiImportTaskRoleInfo) MarshalBinary 

func (m *OpenapiImportTaskRoleInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportTaskRoleInfo) UnmarshalBinary 

func (m *OpenapiImportTaskRoleInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportTaskRoleInfo) Validate 

func (m *OpenapiImportTaskRoleInfo) Validate(formats strfmt.Registry) error

Validate validates this openapi import task role info

type OpenapiImportTaskRoleInfoAwsImportRole 

type OpenapiImportTaskRoleInfoAwsImportRole struct {

	// The account ID under which the import tasks for this cluster are running.
	// Example: 999999999999
	// Required: true
	AccountID *string `json:"account_id"`

	// The unique external ID that binds to the cluster, which is a long string. When an import task starts and attempts to assume a specified role, it automatically attaches this external ID. This means that you can configure this external ID in the assumed role's trust relationship, so that only the import task of that specified cluster can access the data by assuming the role. This can provide additional security.
	// Example: abcdefghijklmnopqrstuvwxyz0123456789xxxxxxxxxxxxxx
	// Required: true
	ExternalID *string `json:"external_id"`
}

OpenapiImportTaskRoleInfoAwsImportRole AwsImportTaskRoleInfo

The import role information for an AWS cluster. Only TiDB clusters on AWS return this information. If the TiDB cluster is deployed on GCP, this field is not returned.

swagger:model OpenapiImportTaskRoleInfoAwsImportRole

func (*OpenapiImportTaskRoleInfoAwsImportRole) ContextValidate 

func (m *OpenapiImportTaskRoleInfoAwsImportRole) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import task role info aws import role based on context it is used

func (*OpenapiImportTaskRoleInfoAwsImportRole) MarshalBinary 

func (m *OpenapiImportTaskRoleInfoAwsImportRole) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportTaskRoleInfoAwsImportRole) UnmarshalBinary 

func (m *OpenapiImportTaskRoleInfoAwsImportRole) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportTaskRoleInfoAwsImportRole) Validate 

func (m *OpenapiImportTaskRoleInfoAwsImportRole) Validate(formats strfmt.Registry) error

Validate validates this openapi import task role info aws import role

type OpenapiImportTaskRoleInfoGcpImportRole 

type OpenapiImportTaskRoleInfoGcpImportRole struct {

	// The account ID under which the import tasks for this cluster are running.
	// Example: example-account@example.com
	// Required: true
	AccountID *string `json:"account_id"`
}

OpenapiImportTaskRoleInfoGcpImportRole GcpImportTaskRoleInfo

The import role information for a GCP cluster. Only TiDB clusters on GCP return this information. If the TiDB cluster is deployed on AWS, this field is not returned.

swagger:model OpenapiImportTaskRoleInfoGcpImportRole

func (*OpenapiImportTaskRoleInfoGcpImportRole) ContextValidate 

func (m *OpenapiImportTaskRoleInfoGcpImportRole) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi import task role info gcp import role based on context it is used

func (*OpenapiImportTaskRoleInfoGcpImportRole) MarshalBinary 

func (m *OpenapiImportTaskRoleInfoGcpImportRole) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiImportTaskRoleInfoGcpImportRole) UnmarshalBinary 

func (m *OpenapiImportTaskRoleInfoGcpImportRole) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiImportTaskRoleInfoGcpImportRole) Validate 

func (m *OpenapiImportTaskRoleInfoGcpImportRole) Validate(formats strfmt.Registry) error

Validate validates this openapi import task role info gcp import role

type OpenapiListAwsCmekResp 

type OpenapiListAwsCmekResp struct {

	// The specifications of the AWS CMEK.
	Items []*OpenapiListAwsCmekRespItemsItems0 `json:"items"`
}

OpenapiListAwsCmekResp ListAwsCmekResp

ListAwsCmekResp is the response for getting AWS Customer-Managed Encryption Keys for a project.

swagger:model openapiListAwsCmekResp

func (*OpenapiListAwsCmekResp) ContextValidate 

func (m *OpenapiListAwsCmekResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list aws cmek resp based on the context it is used

func (*OpenapiListAwsCmekResp) MarshalBinary 

func (m *OpenapiListAwsCmekResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListAwsCmekResp) UnmarshalBinary 

func (m *OpenapiListAwsCmekResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListAwsCmekResp) Validate 

func (m *OpenapiListAwsCmekResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list aws cmek resp

type OpenapiListAwsCmekRespItemsItems0 

type OpenapiListAwsCmekRespItemsItems0 struct {

	// The KMS ARN of the AWS CMEK.
	// Example: arn:aws:kms:example
	// Required: true
	KmsArn *string `json:"kms_arn"`

	// The region name of the AWS CMEK. The region value should match the cloud provider's region code.
	//
	// You can get the complete list of available regions from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// For the detailed information on each region, refer to the documentation of the [AWS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) cloud provider.
	// Example: us-west-2
	// Required: true
	Region *string `json:"region"`
}

OpenapiListAwsCmekRespItemsItems0 AwsCmekSpec

AwsCmekSpec is the specification of the AWS CMEK.

swagger:model OpenapiListAwsCmekRespItemsItems0

func (*OpenapiListAwsCmekRespItemsItems0) ContextValidate 

func (m *OpenapiListAwsCmekRespItemsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list aws cmek resp items items0 based on context it is used

func (*OpenapiListAwsCmekRespItemsItems0) MarshalBinary 

func (m *OpenapiListAwsCmekRespItemsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListAwsCmekRespItemsItems0) UnmarshalBinary 

func (m *OpenapiListAwsCmekRespItemsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListAwsCmekRespItemsItems0) Validate 

func (m *OpenapiListAwsCmekRespItemsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list aws cmek resp items items0

type OpenapiListBackupItem 

type OpenapiListBackupItem struct {

	// The creation time of the backup in UTC. The time format follows the [ISO8601](http://en.wikipedia.org/wiki/ISO_8601) standard, which is `YYYY-MM-DD` (year-month-day) + T +`HH:MM:SS` (hour-minutes-seconds) + Z. For example, `2020-01-01T00:00:00Z`.
	// Example: 2020-01-01T00:00:00Z
	// Format: date-time
	CreateTimestamp strfmt.DateTime `json:"create_timestamp,omitempty"`

	// The description of the backup. It is specified by the user when taking a manual type backup. It helps you add additional information to the backup.
	// Example: backup for cluster upgrade in 2022/06/07
	Description string `json:"description,omitempty"`

	// The ID of the backup. It is generated by TiDB Cloud.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the backup.
	// Example: backup-1
	Name string `json:"name,omitempty"`

	// The bytes of the backup.
	// Example: 102400
	Size string `json:"size,omitempty"`

	// The status of backup.
	// Example: SUCCESS
	// Enum: [PENDING RUNNING FAILED SUCCESS]
	Status string `json:"status,omitempty"`

	// The type of backup. TiDB Cloud only supports manual and auto backup. For more information, see [TiDB Cloud Documentation](https://docs.pingcap.com/tidbcloud/backup-and-restore#backup).
	// Example: MANUAL
	// Enum: [MANUAL AUTO]
	Type string `json:"type,omitempty"`
}

OpenapiListBackupItem ListBackupItem

The item of backup list.

swagger:model openapiListBackupItem

func (*OpenapiListBackupItem) ContextValidate 

func (m *OpenapiListBackupItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list backup item based on context it is used

func (*OpenapiListBackupItem) MarshalBinary 

func (m *OpenapiListBackupItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListBackupItem) UnmarshalBinary 

func (m *OpenapiListBackupItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListBackupItem) Validate 

func (m *OpenapiListBackupItem) Validate(formats strfmt.Registry) error

Validate validates this openapi list backup item

type OpenapiListBackupItemStatusEnum 

type OpenapiListBackupItemStatusEnum string

OpenapiListBackupItemStatusEnum openapi list backup item status enum

swagger:model openapiListBackupItemStatusEnum 

const (

	// OpenapiListBackupItemStatusEnumPENDING captures enum value "PENDING"
	OpenapiListBackupItemStatusEnumPENDING OpenapiListBackupItemStatusEnum = "PENDING"

	// OpenapiListBackupItemStatusEnumRUNNING captures enum value "RUNNING"
	OpenapiListBackupItemStatusEnumRUNNING OpenapiListBackupItemStatusEnum = "RUNNING"

	// OpenapiListBackupItemStatusEnumFAILED captures enum value "FAILED"
	OpenapiListBackupItemStatusEnumFAILED OpenapiListBackupItemStatusEnum = "FAILED"

	// OpenapiListBackupItemStatusEnumSUCCESS captures enum value "SUCCESS"
	OpenapiListBackupItemStatusEnumSUCCESS OpenapiListBackupItemStatusEnum = "SUCCESS"
)

func NewOpenapiListBackupItemStatusEnum 

func NewOpenapiListBackupItemStatusEnum(value OpenapiListBackupItemStatusEnum) *OpenapiListBackupItemStatusEnum

func (OpenapiListBackupItemStatusEnum) ContextValidate 

func (m OpenapiListBackupItemStatusEnum) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list backup item status enum based on context it is used

func (OpenapiListBackupItemStatusEnum) Pointer 

func (m OpenapiListBackupItemStatusEnum) Pointer() *OpenapiListBackupItemStatusEnum

Pointer returns a pointer to a freshly-allocated OpenapiListBackupItemStatusEnum.

func (OpenapiListBackupItemStatusEnum) Validate 

func (m OpenapiListBackupItemStatusEnum) Validate(formats strfmt.Registry) error

Validate validates this openapi list backup item status enum

type OpenapiListBackupOfClusterResp 

type OpenapiListBackupOfClusterResp struct {

	// The items of all backups.
	Items []*OpenapiListBackupOfClusterRespItemsItems0 `json:"items"`

	// The total number of backups in the project.
	// Example: 10
	Total int64 `json:"total,omitempty"`
}

OpenapiListBackupOfClusterResp ListBackupOfClusterResp

The response for listing backups of a cluster.

swagger:model openapiListBackupOfClusterResp

func (*OpenapiListBackupOfClusterResp) ContextValidate 

func (m *OpenapiListBackupOfClusterResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list backup of cluster resp based on the context it is used

func (*OpenapiListBackupOfClusterResp) MarshalBinary 

func (m *OpenapiListBackupOfClusterResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListBackupOfClusterResp) UnmarshalBinary 

func (m *OpenapiListBackupOfClusterResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListBackupOfClusterResp) Validate 

func (m *OpenapiListBackupOfClusterResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list backup of cluster resp

type OpenapiListBackupOfClusterRespItemsItems0 

type OpenapiListBackupOfClusterRespItemsItems0 struct {

	// The creation time of the backup in UTC. The time format follows the [ISO8601](http://en.wikipedia.org/wiki/ISO_8601) standard, which is `YYYY-MM-DD` (year-month-day) + T +`HH:MM:SS` (hour-minutes-seconds) + Z. For example, `2020-01-01T00:00:00Z`.
	// Example: 2020-01-01T00:00:00Z
	// Format: date-time
	CreateTimestamp strfmt.DateTime `json:"create_timestamp,omitempty"`

	// The description of the backup. It is specified by the user when taking a manual type backup. It helps you add additional information to the backup.
	// Example: backup for cluster upgrade in 2022/06/07
	Description string `json:"description,omitempty"`

	// The ID of the backup. It is generated by TiDB Cloud.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the backup.
	// Example: backup-1
	Name string `json:"name,omitempty"`

	// The bytes of the backup.
	// Example: 102400
	Size string `json:"size,omitempty"`

	// The status of backup.
	// Example: SUCCESS
	// Enum: [PENDING RUNNING FAILED SUCCESS]
	Status string `json:"status,omitempty"`

	// The type of backup. TiDB Cloud only supports manual and auto backup. For more information, see [TiDB Cloud Documentation](https://docs.pingcap.com/tidbcloud/backup-and-restore#backup).
	// Example: MANUAL
	// Enum: [MANUAL AUTO]
	Type string `json:"type,omitempty"`
}

OpenapiListBackupOfClusterRespItemsItems0 ListBackupItem

The item of backup list.

swagger:model OpenapiListBackupOfClusterRespItemsItems0

func (*OpenapiListBackupOfClusterRespItemsItems0) ContextValidate 

func (m *OpenapiListBackupOfClusterRespItemsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list backup of cluster resp items items0 based on context it is used

func (*OpenapiListBackupOfClusterRespItemsItems0) MarshalBinary 

func (m *OpenapiListBackupOfClusterRespItemsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListBackupOfClusterRespItemsItems0) UnmarshalBinary 

func (m *OpenapiListBackupOfClusterRespItemsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListBackupOfClusterRespItemsItems0) Validate 

func (m *OpenapiListBackupOfClusterRespItemsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list backup of cluster resp items items0

type OpenapiListClustersOfProjectResp 

type OpenapiListClustersOfProjectResp struct {

	// The items of clusters in the project.
	// Required: true
	Items []*OpenapiListClustersOfProjectRespItemsItems0 `json:"items"`

	// The total number of clusters in the project.
	// Example: 1
	// Required: true
	Total *int64 `json:"total"`
}

OpenapiListClustersOfProjectResp GetClustersOfProjectResp

GetClustersOfProjectResp is the response for getting clusters of project.

swagger:model openapiListClustersOfProjectResp

func (*OpenapiListClustersOfProjectResp) ContextValidate 

func (m *OpenapiListClustersOfProjectResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list clusters of project resp based on the context it is used

func (*OpenapiListClustersOfProjectResp) MarshalBinary 

func (m *OpenapiListClustersOfProjectResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectResp) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectResp) Validate 

func (m *OpenapiListClustersOfProjectResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp

type OpenapiListClustersOfProjectRespItemsItems0 

type OpenapiListClustersOfProjectRespItemsItems0 struct {

	// The cloud provider on which your TiDB cluster is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// The cluster type:
	// - `"DEVELOPER"`: a [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) cluster
	// - `"DEDICATED"`: a [TiDB Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#dedicated-tier) cluster
	//
	// **Warning:** `"DEVELOPER"` will soon be changed to `"SERVERLESS"` to represent TiDB Serverless clusters.
	// Example: DEDICATED
	// Enum: [DEDICATED DEVELOPER]
	ClusterType string `json:"cluster_type,omitempty"`

	// config
	Config *OpenapiListClustersOfProjectRespItemsItems0Config `json:"config,omitempty"`

	// The creation time of the cluster in Unix timestamp seconds (epoch time).
	// Example: 1656991448
	CreateTimestamp string `json:"create_timestamp,omitempty"`

	// The ID of the cluster.
	// Example: 1
	// Required: true
	ID *string `json:"id"`

	// The name of the cluster.
	// Example: Cluster0
	// Pattern: ^[A-Za-z0-9][-A-Za-z0-9]{2,62}[A-Za-z0-9]$
	Name string `json:"name,omitempty"`

	// The ID of the project.
	// Example: 1
	// Required: true
	ProjectID *string `json:"project_id"`

	// Region of the cluster.
	// Example: us-west-2
	Region string `json:"region,omitempty"`

	// status
	Status *OpenapiListClustersOfProjectRespItemsItems0Status `json:"status,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0 ClusterItem

ClusterItem is the information of cluster.

swagger:model OpenapiListClustersOfProjectRespItemsItems0

func (*OpenapiListClustersOfProjectRespItemsItems0) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list clusters of project resp items items0 based on the context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0

type OpenapiListClustersOfProjectRespItemsItems0Config 

type OpenapiListClustersOfProjectRespItemsItems0Config struct {

	// components
	Components *OpenapiListClustersOfProjectRespItemsItems0ConfigComponents `json:"components,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0Config The configuration of the cluster. Example: {"components":{"tidb":{"node_quantity":2,"node_size":"8C16G"},"tikv":{"node_quantity":3,"node_size":"8C32G","storage_size_gib":1024}},"port":4000}

swagger:model OpenapiListClustersOfProjectRespItemsItems0Config

func (*OpenapiListClustersOfProjectRespItemsItems0Config) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0Config) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list clusters of project resp items items0 config based on the context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0Config) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0Config) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0Config) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0Config) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0Config) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0Config) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 config

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponents 

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponents struct {

	// tidb
	// Required: true
	Tidb *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb `json:"tidb"`

	// tiflash
	Tiflash *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash `json:"tiflash,omitempty"`

	// tikv
	// Required: true
	Tikv *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv `json:"tikv"`
}

OpenapiListClustersOfProjectRespItemsItems0ConfigComponents The components of the cluster. Example: {"tidb":{"node_quantity":2,"node_size":"8C16G"},"tikv":{"node_quantity":3,"node_size":"8C32G","storage_size_gib":1024}}

swagger:model OpenapiListClustersOfProjectRespItemsItems0ConfigComponents

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list clusters of project resp items items0 config components based on the context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponents) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 config components

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb 

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 2
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C16G
	// Required: true
	NodeSize *string `json:"node_size"`
}

OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb The TiDB component of the cluster.

swagger:model OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 config components tidb based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTidb) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 config components tidb

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash 

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash The TiFlash component of the cluster.

swagger:model OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 config components tiflash based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTiflash) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 config components tiflash

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv 

type OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 3
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv The TiKV component of the cluster.

swagger:model OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 config components tikv based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0ConfigComponentsTikv) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 config components tikv

type OpenapiListClustersOfProjectRespItemsItems0Status 

type OpenapiListClustersOfProjectRespItemsItems0Status struct {

	// Status of the cluster.
	// Example: AVAILABLE
	// Enum: [AVAILABLE CREATING MODIFYING PAUSED RESUMING UNAVAILABLE IMPORTING MAINTAINING PAUSING]
	ClusterStatus string `json:"cluster_status,omitempty"`

	// connection strings
	ConnectionStrings *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings `json:"connection_strings,omitempty"`

	// node map
	NodeMap *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap `json:"node_map,omitempty"`

	// TiDB version.
	// Example: v6.1.0
	TidbVersion string `json:"tidb_version,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0Status ClusterItemStatus

The status of the cluster.

swagger:model OpenapiListClustersOfProjectRespItemsItems0Status

func (*OpenapiListClustersOfProjectRespItemsItems0Status) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0Status) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list clusters of project resp items items0 status based on the context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0Status) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0Status) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0Status) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0Status) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0Status) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0Status) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status

type OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings 

type OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings struct {

	// The default TiDB user for connection.
	// Example: root
	DefaultUser string `json:"default_user,omitempty"`

	// standard
	Standard *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard `json:"standard,omitempty"`

	// vpc peering
	VpcPeering *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering `json:"vpc_peering,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings Connection strings.

swagger:model OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list clusters of project resp items items0 status connection strings based on the context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStrings) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status connection strings

type OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard 

type OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard struct {

	// The host of standard connection.
	// Example: tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard Standard connection string.

You must configure the [IP Access List](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster#connect-via-standard-connection) for the cluster you created on [TiDB Cloud console](https://tidbcloud.com/) before connecting to this connection string.

swagger:model OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 status connection strings standard based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsStandard) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status connection strings standard

type OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering 

type OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering struct {

	// The host of VPC peering connection.
	// Example: private-tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering [VPC peering](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary#vpc-peering) connection string.

You must [Set up VPC peering connections](https://docs.pingcap.com/tidbcloud/set-up-vpc-peering-connections) for the project before connecting to this private connection string.

swagger:model OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 status connection strings vpc peering based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusConnectionStringsVpcPeering) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status connection strings vpc peering

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap 

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap struct {

	// TiDB node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tidb-0","node_size":"8C16G","ram_bytes":"17179869184","status":"NODE_STATUS_AVAILABLE","vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tidb-1","node_size":"8C16G","ram_bytes":"17179869184","status":"NODE_STATUS_AVAILABLE","vcpu_num":8}]
	// Required: true
	Tidb []*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0 `json:"tidb"`

	// TiFlash node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tiflash-0","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tiflash-1","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8}]
	Tiflash []*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0 `json:"tiflash"`

	// TiKV node map.
	// Example: [{"availability_zone":"us-west-2a","node_name":"tikv-0","node_size":"8C32G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2b","node_name":"tikv-1","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8},{"availability_zone":"us-west-2c","node_name":"tikv-2","node_size":"8C64G","ram_bytes":"68719476736","status":"NODE_STATUS_AVAILABLE","storage_size_gib":1024,"vcpu_num":8}]
	// Required: true
	Tikv []*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0 `json:"tikv"`
}

OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap Node map. The `node_map` is returned only when the `cluster_status` is `"AVAILABLE"` or `"MODIFYING"`.

swagger:model OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list clusters of project resp items items0 status node map based on the context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMap) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status node map

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0 

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tidb-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiDB component in the cluster.
	// Example: 8C16G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 17179869184
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0 openapi list clusters of project resp items items0 status node map tidb items0

swagger:model OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 status node map tidb items0 based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTidbItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status node map tidb items0

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0 

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tiflash-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiFlash component in the cluster.
	// Example: 8C64G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0 openapi list clusters of project resp items items0 status node map tiflash items0

swagger:model OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 status node map tiflash items0 based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTiflashItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status node map tiflash items0

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0 

type OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0 struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tikv-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiKV component in the cluster.
	// Example: 8C32G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0 openapi list clusters of project resp items items0 status node map tikv items0

swagger:model OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) ContextValidate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list clusters of project resp items items0 status node map tikv items0 based on context it is used

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) MarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) UnmarshalBinary 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) Validate 

func (m *OpenapiListClustersOfProjectRespItemsItems0StatusNodeMapTikvItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list clusters of project resp items items0 status node map tikv items0

type OpenapiListImportTasksResp 

type OpenapiListImportTasksResp struct {

	// The import tasks in the cluster in the request page area.
	// Required: true
	Items []*OpenapiListImportTasksRespItemsItems0 `json:"items"`

	// The total number of import tasks in the cluster.
	// Example: 20
	// Required: true
	Total *int64 `json:"total"`
}

OpenapiListImportTasksResp ListImportTasksResp

ListImportTasksResp is the response for listing the import tasks of a cluster.

swagger:model openapiListImportTasksResp

func (*OpenapiListImportTasksResp) ContextValidate 

func (m *OpenapiListImportTasksResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list import tasks resp based on the context it is used

func (*OpenapiListImportTasksResp) MarshalBinary 

func (m *OpenapiListImportTasksResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksResp) UnmarshalBinary 

func (m *OpenapiListImportTasksResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksResp) Validate 

func (m *OpenapiListImportTasksResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp

type OpenapiListImportTasksRespItemsItems0 

type OpenapiListImportTasksRespItemsItems0 struct {

	// metadata
	Metadata *OpenapiListImportTasksRespItemsItems0Metadata `json:"metadata,omitempty"`

	// spec
	Spec *OpenapiListImportTasksRespItemsItems0Spec `json:"spec,omitempty"`

	// status
	Status *OpenapiListImportTasksRespItemsItems0Status `json:"status,omitempty"`
}

OpenapiListImportTasksRespItemsItems0 ImportItem

ImportItem represents the information of a single import task.

swagger:model OpenapiListImportTasksRespItemsItems0

func (*OpenapiListImportTasksRespItemsItems0) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list import tasks resp items items0 based on the context it is used

func (*OpenapiListImportTasksRespItemsItems0) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0) Validate 

func (m *OpenapiListImportTasksRespItemsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0

type OpenapiListImportTasksRespItemsItems0Metadata 

type OpenapiListImportTasksRespItemsItems0Metadata struct {

	// The creation time of the import task in Unix timestamp seconds (epoch time).
	// Example: 1676450597
	// Required: true
	CreateTimestamp *string `json:"create_timestamp"`

	// The ID of the import task.
	// Example: 1
	// Required: true
	ID *string `json:"id"`

	// The name of the import task.
	// Example: my_import
	Name string `json:"name,omitempty"`
}

OpenapiListImportTasksRespItemsItems0Metadata ImportMetadata

The metadata of the import task.

swagger:model OpenapiListImportTasksRespItemsItems0Metadata

func (*OpenapiListImportTasksRespItemsItems0Metadata) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0Metadata) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list import tasks resp items items0 metadata based on context it is used

func (*OpenapiListImportTasksRespItemsItems0Metadata) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0Metadata) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0Metadata) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0Metadata) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0Metadata) Validate 

func (m *OpenapiListImportTasksRespItemsItems0Metadata) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 metadata

type OpenapiListImportTasksRespItemsItems0Spec 

type OpenapiListImportTasksRespItemsItems0Spec struct {

	// source
	// Required: true
	Source *OpenapiListImportTasksRespItemsItems0SpecSource `json:"source"`

	// target
	// Required: true
	Target *OpenapiListImportTasksRespItemsItems0SpecTarget `json:"target"`
}

OpenapiListImportTasksRespItemsItems0Spec ImportSpec

The specification of the import task.

swagger:model OpenapiListImportTasksRespItemsItems0Spec

func (*OpenapiListImportTasksRespItemsItems0Spec) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0Spec) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list import tasks resp items items0 spec based on the context it is used

func (*OpenapiListImportTasksRespItemsItems0Spec) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0Spec) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0Spec) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0Spec) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0Spec) Validate 

func (m *OpenapiListImportTasksRespItemsItems0Spec) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec

type OpenapiListImportTasksRespItemsItems0SpecSource 

type OpenapiListImportTasksRespItemsItems0SpecSource struct {

	// aws assume role access
	AwsAssumeRoleAccess *OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess `json:"aws_assume_role_access,omitempty"`

	// aws key access
	AwsKeyAccess *OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess `json:"aws_key_access,omitempty"`

	// format
	// Required: true
	Format *OpenapiListImportTasksRespItemsItems0SpecSourceFormat `json:"format"`

	// The data source type of an import task.
	//
	// - `"S3"`: import data from Amazon S3
	// - `"GCS"`: import data from Google Cloud Storage
	// - `"LOCAL_FILE"`: import data from a local file (only available for [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters). Before you import from a local file, you need to first upload the file using the [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile) endpoint.
	//
	// **Note:** Currently, if this import spec is used for a [preview](#tag/Import/operation/PreviewImportData) request, only the `LOCAL_FILE` source type is supported.
	// Example: S3
	// Required: true
	// Enum: [S3 GCS LOCAL_FILE]
	Type *string `json:"type"`

	// The data source URI of an import task. The URI scheme must match the data source type. Here are the scheme of each source type:
	// * `S3`: `s3://`
	// * `GCS`: `gs://`
	// * `LOCAL_FILE`: `file://`.
	//
	// **Note:** If the import source type is `LOCAL_FILE`, just provide the `upload_stub_id` of the uploaded file from the response of [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile), and make it as the data source folder. For example: `file://12345/`.
	//
	// **Limitation**: If the import source type is `LOCAL_FILE`, only the `CSV` source format type is supported.
	// Example: s3://example-bucket/example-source-data/
	// Required: true
	URI *string `json:"uri"`
}

OpenapiListImportTasksRespItemsItems0SpecSource ImportSource

The data source settings of the import task.

swagger:model OpenapiListImportTasksRespItemsItems0SpecSource

func (*OpenapiListImportTasksRespItemsItems0SpecSource) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSource) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list import tasks resp items items0 spec source based on the context it is used

func (*OpenapiListImportTasksRespItemsItems0SpecSource) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSource) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSource) Validate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSource) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec source

type OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess 

type OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess struct {

	// The specific AWS role ARN that needs to be assumed to access the Amazon S3 data source.
	// Example: arn:aws:iam::999999999999:role/sample-role
	// Required: true
	AssumeRole *string `json:"assume_role"`
}

OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess AwsAssumeRoleAccess

The settings to access the S3 data by assuming a specific AWS role. This field is only needed if you need to access S3 data by assuming an AWS role.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list import tasks resp items items0 spec source aws assume role access based on context it is used

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) Validate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsAssumeRoleAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec source aws assume role access

type OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess 

type OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess struct {

	// The access key ID of the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_ACCESS_KEY_ID
	// Required: true
	AccessKeyID *string `json:"access_key_id"`

	// The secret access key for the account to access the data. This information will be redacted when it is retrieved to obtain the import task information.
	// Example: YOUR_SECRET_ACCESS_KEY
	// Required: true
	SecretAccessKey *string `json:"secret_access_key"`
}

OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess AwsKeyAccess

The settings to access the S3 data with an access key. This field is only needed if you want to access the S3 data with an access key.

**Note:** Provide only one of `aws_assume_role_access` and `aws_key_access`. If both `aws_assume_role_access` and `aws_key_access` are provided, an error will be reported.

swagger:model OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list import tasks resp items items0 spec source aws key access based on context it is used

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) Validate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceAwsKeyAccess) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec source aws key access

type OpenapiListImportTasksRespItemsItems0SpecSourceFormat 

type OpenapiListImportTasksRespItemsItems0SpecSourceFormat struct {

	// csv config
	CsvConfig *OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig `json:"csv_config,omitempty"`

	// The format type of an import source.
	// Example: CSV
	// Required: true
	// Enum: [CSV PARQUET SQL AURORA_SNAPSHOT]
	Type *string `json:"type"`
}

OpenapiListImportTasksRespItemsItems0SpecSourceFormat ImportSourceFormat

The format settings of the import data source.

swagger:model OpenapiListImportTasksRespItemsItems0SpecSourceFormat

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormat) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormat) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list import tasks resp items items0 spec source format based on the context it is used

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormat) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormat) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormat) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormat) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormat) Validate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormat) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec source format

type OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig 

type OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig struct {

	// Whether a backslash (`\`) symbol followed by a character should be combined as a whole and treated as an escape sequence in a CSV field. For example, if this parameter is set to `true`, `\n` will be treated as a 'new-line' character. If it is set to `false`, `\n` will be treated as two separate characters: backslash and `n`.
	//
	// Currently, these are several supported escape sequences: `\0`, `\b`, `\n`, `\r`, `\t`, and `\Z`. If the parameter is set to `true`, but the backslash escape sequence is not recognized, the backslash character is ignored.
	BackslashEscape *bool `json:"backslash_escape,omitempty"`

	// The delimiter character used to separate fields in the CSV data.
	Delimiter *string `json:"delimiter,omitempty"`

	// Whether the CSV data has a header row, which is not part of the data. If it is set to `true`, the import task will use the column names in the header row to match the column names in the target table.
	HasHeaderRow *bool `json:"has_header_row,omitempty"`

	// The character used to quote the fields in the CSV data.
	Quote *string `json:"quote,omitempty"`
}

OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig ImportSourceCSVConfig

The CSV format settings to parse the source CSV files. This field is only needed if the source format is CSV.

swagger:model OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list import tasks resp items items0 spec source format csv config based on context it is used

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) Validate 

func (m *OpenapiListImportTasksRespItemsItems0SpecSourceFormatCsvConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec source format csv config

type OpenapiListImportTasksRespItemsItems0SpecTarget 

type OpenapiListImportTasksRespItemsItems0SpecTarget struct {

	// The settings for each target table that is being imported for the import task. If you leave it empty, the system will scan all the files in the data source using the default file patterns and collect all the tables to import. The files include data files, table schema files, and DB schema files. If you provide a list of tables, only those tables will be imported. For more information about the default file pattern, see [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Limitations:**
	// * Currently, if you want to use a custom filename pattern, you can only specify one table. If all the tables use the default filename pattern, you can specify more than one target table in `tables`.
	// * It is recommended that you pre-create the target tables before creating an import task. You can do this either by executing the `CREATE TABLE` statement in the cluster or by specifying the table definition in the table creation options.
	// * If a target table is not created, the import module tries to find a **TABLE SCHEMA FILE** containing the `CREATE TABLE` statement of the table in the data source folder with the name `${db_name}.${table_name}-schema.sql` (for example, `db01.tbl01-schema.sql`). If this file is found, the `CREATE TABLE` statement is automatically executed if the table doesn't exist before the actual import process starts. If the table is still missing after this pre-create step, an error will occur.
	Tables []*OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0 `json:"tables"`
}

OpenapiListImportTasksRespItemsItems0SpecTarget ImportTarget

The target settings of the import task.

swagger:model OpenapiListImportTasksRespItemsItems0SpecTarget

func (*OpenapiListImportTasksRespItemsItems0SpecTarget) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0SpecTarget) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list import tasks resp items items0 spec target based on the context it is used

func (*OpenapiListImportTasksRespItemsItems0SpecTarget) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecTarget) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecTarget) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecTarget) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecTarget) Validate 

func (m *OpenapiListImportTasksRespItemsItems0SpecTarget) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec target

type OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0 

type OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0 struct {

	// The target database name.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// The filename pattern used to map the files in the data source to this target table. The pattern should be a simple glob pattern. Here are some examples:
	// * `my-data?.csv`: all CSV files starting with `my-data` and one character (such as `my-data1.csv` and `my-data2.csv`) will be imported into the same target table.
	// * `my-data*.csv`: all CSV files starting with `my-data` will be imported into the same target table.
	//
	// If no pattern is specified, a default pattern is used. The default pattern will try to find files with this naming convention as the data files for this table: `${db_name}.${table_name}.[numeric_index].${format_suffix}`.
	//
	// Here are some examples of filenames that can be matched as data files for the table `db01.table01`: `db01.table01.csv`, `db01.table01.00001.csv`.
	//
	// For more information about the custom file pattern and the default pattern, refer to [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](https://docs.pingcap.com/tidbcloud/import-csv-files).
	//
	// **Note:** For `LOCAL_FILE` import tasks, use the local file name for this field. The local file name must match the local file name in [Upload a local file for an import task](#tag/Import/operation/UploadLocalFile).
	// Example: data/db01/table01.*.csv
	FileNamePattern string `json:"file_name_pattern,omitempty"`

	// The target table name.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0 ImportTargetTable

ImportTargetTable represents the settings for importing source data into a single target table of an import task.

swagger:model OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0

func (*OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list import tasks resp items items0 spec target tables items0 based on context it is used

func (*OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) Validate 

func (m *OpenapiListImportTasksRespItemsItems0SpecTargetTablesItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 spec target tables items0

type OpenapiListImportTasksRespItemsItems0Status 

type OpenapiListImportTasksRespItemsItems0Status struct {

	// The end timestamp of the import task. The format is Unix timestamp (the seconds elapsed since the Unix epoch).
	// Example: 1676450897
	EndTimestamp string `json:"end_timestamp,omitempty"`

	// The error message of the import task.
	// Example: some error occurs
	ErrorMessage string `json:"error_message,omitempty"`

	// The current phase that the import task is in.
	// Example: IMPORTING
	// Required: true
	// Enum: [PREPARING IMPORTING COMPLETED FAILED CANCELING CANCELED]
	Phase *string `json:"phase"`

	// progress
	Progress *OpenapiListImportTasksRespItemsItems0StatusProgress `json:"progress,omitempty"`

	// The total size of the import task's data source. The unit is bytes.
	// Example: 10737418240
	SourceTotalSizeBytes string `json:"source_total_size_bytes,omitempty"`

	// The start timestamp of the import task. The format is Unix timestamp (the seconds elapsed since the Unix epoch)
	// Example: 1676450597
	StartTimestamp string `json:"start_timestamp,omitempty"`
}

OpenapiListImportTasksRespItemsItems0Status ImportStatus

The status of the import task.

swagger:model OpenapiListImportTasksRespItemsItems0Status

func (*OpenapiListImportTasksRespItemsItems0Status) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0Status) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list import tasks resp items items0 status based on the context it is used

func (*OpenapiListImportTasksRespItemsItems0Status) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0Status) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0Status) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0Status) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0Status) Validate 

func (m *OpenapiListImportTasksRespItemsItems0Status) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 status

type OpenapiListImportTasksRespItemsItems0StatusProgress 

type OpenapiListImportTasksRespItemsItems0StatusProgress struct {

	// The overall importing progress of the import task.
	// Example: 59
	// Required: true
	// Maximum: 100
	ImportProgress *float64 `json:"import_progress"`

	// The overall validation progress of the import task after the data has been imported into the target cluster.
	// Example: 59
	// Required: true
	// Maximum: 100
	ValidationProgress *float64 `json:"validation_progress"`
}

OpenapiListImportTasksRespItemsItems0StatusProgress ImportProgress

The progress of the import task.

swagger:model OpenapiListImportTasksRespItemsItems0StatusProgress

func (*OpenapiListImportTasksRespItemsItems0StatusProgress) ContextValidate 

func (m *OpenapiListImportTasksRespItemsItems0StatusProgress) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list import tasks resp items items0 status progress based on context it is used

func (*OpenapiListImportTasksRespItemsItems0StatusProgress) MarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0StatusProgress) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0StatusProgress) UnmarshalBinary 

func (m *OpenapiListImportTasksRespItemsItems0StatusProgress) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListImportTasksRespItemsItems0StatusProgress) Validate 

func (m *OpenapiListImportTasksRespItemsItems0StatusProgress) Validate(formats strfmt.Registry) error

Validate validates this openapi list import tasks resp items items0 status progress

type OpenapiListPrivateEndpointsOfProjectResp 

type OpenapiListPrivateEndpointsOfProjectResp struct {

	// The private endpoints in the project.
	// Required: true
	Endpoints []*OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0 `json:"endpoints"`
}

OpenapiListPrivateEndpointsOfProjectResp ListPrivateEndpointsOfProjectResp

ListPrivateEndpointsOfProjectResp is the response for listing private endpoints for a project.

swagger:model openapiListPrivateEndpointsOfProjectResp

func (*OpenapiListPrivateEndpointsOfProjectResp) ContextValidate 

func (m *OpenapiListPrivateEndpointsOfProjectResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list private endpoints of project resp based on the context it is used

func (*OpenapiListPrivateEndpointsOfProjectResp) MarshalBinary 

func (m *OpenapiListPrivateEndpointsOfProjectResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsOfProjectResp) UnmarshalBinary 

func (m *OpenapiListPrivateEndpointsOfProjectResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsOfProjectResp) Validate 

func (m *OpenapiListPrivateEndpointsOfProjectResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list private endpoints of project resp

type OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0 

type OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0 struct {

	// [Output Only] The cloud provider on which the private endpoint service is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// [Output Only] The ID of the cluster.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// [Output Only] The name of the cluster.
	// Example: Cluster0
	ClusterName string `json:"cluster_name,omitempty"`

	// The format of the private endpoint name varies by cloud provider: `"vpce-xxxx"` for AWS and `"projects/xxx/regions/xxx/forwardingRules/xxx"` for Google Cloud.
	// Example: vpce-01234567890123456
	EndpointName string `json:"endpoint_name,omitempty"`

	// [Output Only] The ID of private endpoint. It is used when you [deleting the endpoint](#tag/Cluster/operation/DeletePrivateEndpoint).
	// Example: 1
	ID string `json:"id,omitempty"`

	// [Output Only] The detailed message when the `status` is "FAILED".
	// Example: The endpoint does not exist.
	Message string `json:"message,omitempty"`

	// [Output Only] The region where the private endpoint is hosted, such as Oregon in AWS.
	// Example: Oregon
	RegionName string `json:"region_name,omitempty"`

	// [Output Only] The service name of the private endpoint.
	// Example: com.amazonaws.vpce.us-west-2.vpce-svc-01234567890123456
	ServiceName string `json:"service_name,omitempty"`

	// [Output Only] The status of the private endpoint service.
	// Example: ACTIVE
	// Enum: [CREATING ACTIVE DELETING]
	ServiceStatus string `json:"service_status,omitempty"`

	// [Output Only] The status of the private endpoint.
	// Example: FAILED
	// Enum: [PENDING ACTIVE DELETING FAILED]
	Status string `json:"status,omitempty"`
}

OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0 openapi list private endpoints of project resp endpoints items0

swagger:model OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0

func (*OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) ContextValidate 

func (m *OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list private endpoints of project resp endpoints items0 based on context it is used

func (*OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) MarshalBinary 

func (m *OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) UnmarshalBinary 

func (m *OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) Validate 

func (m *OpenapiListPrivateEndpointsOfProjectRespEndpointsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list private endpoints of project resp endpoints items0

type OpenapiListPrivateEndpointsResp 

type OpenapiListPrivateEndpointsResp struct {

	// The private endpoints for the cluster.
	// Required: true
	Endpoints []*OpenapiListPrivateEndpointsRespEndpointsItems0 `json:"endpoints"`
}

OpenapiListPrivateEndpointsResp ListPrivateEndpointsResp

ListPrivateEndpointsResp is the response for listing private endpoints for a cluster.

swagger:model openapiListPrivateEndpointsResp

func (*OpenapiListPrivateEndpointsResp) ContextValidate 

func (m *OpenapiListPrivateEndpointsResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list private endpoints resp based on the context it is used

func (*OpenapiListPrivateEndpointsResp) MarshalBinary 

func (m *OpenapiListPrivateEndpointsResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsResp) UnmarshalBinary 

func (m *OpenapiListPrivateEndpointsResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsResp) Validate 

func (m *OpenapiListPrivateEndpointsResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list private endpoints resp

type OpenapiListPrivateEndpointsRespEndpointsItems0 

type OpenapiListPrivateEndpointsRespEndpointsItems0 struct {

	// [Output Only] The cloud provider on which the private endpoint service is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// [Output Only] The ID of the cluster.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// [Output Only] The name of the cluster.
	// Example: Cluster0
	ClusterName string `json:"cluster_name,omitempty"`

	// The format of the private endpoint name varies by cloud provider: `"vpce-xxxx"` for AWS and `"projects/xxx/regions/xxx/forwardingRules/xxx"` for Google Cloud.
	// Example: vpce-01234567890123456
	EndpointName string `json:"endpoint_name,omitempty"`

	// [Output Only] The ID of private endpoint. It is used when you [deleting the endpoint](#tag/Cluster/operation/DeletePrivateEndpoint).
	// Example: 1
	ID string `json:"id,omitempty"`

	// [Output Only] The detailed message when the `status` is "FAILED".
	// Example: The endpoint does not exist.
	Message string `json:"message,omitempty"`

	// [Output Only] The region where the private endpoint is hosted, such as Oregon in AWS.
	// Example: Oregon
	RegionName string `json:"region_name,omitempty"`

	// [Output Only] The service name of the private endpoint.
	// Example: com.amazonaws.vpce.us-west-2.vpce-svc-01234567890123456
	ServiceName string `json:"service_name,omitempty"`

	// [Output Only] The status of the private endpoint service.
	// Example: ACTIVE
	// Enum: [CREATING ACTIVE DELETING]
	ServiceStatus string `json:"service_status,omitempty"`

	// [Output Only] The status of the private endpoint.
	// Example: FAILED
	// Enum: [PENDING ACTIVE DELETING FAILED]
	Status string `json:"status,omitempty"`
}

OpenapiListPrivateEndpointsRespEndpointsItems0 openapi list private endpoints resp endpoints items0

swagger:model OpenapiListPrivateEndpointsRespEndpointsItems0

func (*OpenapiListPrivateEndpointsRespEndpointsItems0) ContextValidate 

func (m *OpenapiListPrivateEndpointsRespEndpointsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list private endpoints resp endpoints items0 based on context it is used

func (*OpenapiListPrivateEndpointsRespEndpointsItems0) MarshalBinary 

func (m *OpenapiListPrivateEndpointsRespEndpointsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsRespEndpointsItems0) UnmarshalBinary 

func (m *OpenapiListPrivateEndpointsRespEndpointsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListPrivateEndpointsRespEndpointsItems0) Validate 

func (m *OpenapiListPrivateEndpointsRespEndpointsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list private endpoints resp endpoints items0

type OpenapiListProjectItem 

type OpenapiListProjectItem struct {

	// Flag that indicates whether to enable AWS Customer-Managed Encryption Keys (CMEK). For more information, see [Encryption at Rest using CMEK](https://docs.pingcap.com/tidbcloud/tidb-cloud-encrypt-cmek).
	//
	// **Note:** Currently, this feature is only available upon request. If you need to try out this feature, contact [support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support).
	// Example: false
	AwsCmekEnabled *bool `json:"aws_cmek_enabled,omitempty"`

	// The number of TiDB Cloud clusters deployed in the project.
	// Example: 4
	ClusterCount int64 `json:"cluster_count,omitempty"`

	// The creation time of the cluster in Unix timestamp seconds (epoch time).
	// Example: 1656991448
	CreateTimestamp string `json:"create_timestamp,omitempty"`

	// The ID of the project.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the project.
	// Example: default_project
	Name string `json:"name,omitempty"`

	// The ID of the TiDB Cloud organization to which the project belongs.
	// Example: 1
	OrgID string `json:"org_id,omitempty"`

	// The number of users in the project.
	// Example: 10
	UserCount int64 `json:"user_count,omitempty"`
}

OpenapiListProjectItem ListProjectItem

ListProjectItem is the item of projects.

swagger:model openapiListProjectItem

func (*OpenapiListProjectItem) ContextValidate 

func (m *OpenapiListProjectItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list project item based on context it is used

func (*OpenapiListProjectItem) MarshalBinary 

func (m *OpenapiListProjectItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProjectItem) UnmarshalBinary 

func (m *OpenapiListProjectItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProjectItem) Validate 

func (m *OpenapiListProjectItem) Validate(formats strfmt.Registry) error

Validate validates this openapi list project item

type OpenapiListProjectsResp 

type OpenapiListProjectsResp struct {

	// The items of accessible projects.
	// Required: true
	Items []*OpenapiListProjectsRespItemsItems0 `json:"items"`

	// The total number of accessible projects.
	// Example: 1
	// Required: true
	Total *int64 `json:"total"`
}

OpenapiListProjectsResp GetProjectsResp

GetProjectsResp is the response for getting accessible projects.

swagger:model openapiListProjectsResp

func (*OpenapiListProjectsResp) ContextValidate 

func (m *OpenapiListProjectsResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list projects resp based on the context it is used

func (*OpenapiListProjectsResp) MarshalBinary 

func (m *OpenapiListProjectsResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProjectsResp) UnmarshalBinary 

func (m *OpenapiListProjectsResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProjectsResp) Validate 

func (m *OpenapiListProjectsResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list projects resp

type OpenapiListProjectsRespItemsItems0 

type OpenapiListProjectsRespItemsItems0 struct {

	// Flag that indicates whether to enable AWS Customer-Managed Encryption Keys (CMEK). For more information, see [Encryption at Rest using CMEK](https://docs.pingcap.com/tidbcloud/tidb-cloud-encrypt-cmek).
	//
	// **Note:** Currently, this feature is only available upon request. If you need to try out this feature, contact [support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support).
	// Example: false
	AwsCmekEnabled *bool `json:"aws_cmek_enabled,omitempty"`

	// The number of TiDB Cloud clusters deployed in the project.
	// Example: 4
	ClusterCount int64 `json:"cluster_count,omitempty"`

	// The creation time of the cluster in Unix timestamp seconds (epoch time).
	// Example: 1656991448
	CreateTimestamp string `json:"create_timestamp,omitempty"`

	// The ID of the project.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the project.
	// Example: default_project
	Name string `json:"name,omitempty"`

	// The ID of the TiDB Cloud organization to which the project belongs.
	// Example: 1
	OrgID string `json:"org_id,omitempty"`

	// The number of users in the project.
	// Example: 10
	UserCount int64 `json:"user_count,omitempty"`
}

OpenapiListProjectsRespItemsItems0 ListProjectItem

ListProjectItem is the item of projects.

swagger:model OpenapiListProjectsRespItemsItems0

func (*OpenapiListProjectsRespItemsItems0) ContextValidate 

func (m *OpenapiListProjectsRespItemsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list projects resp items items0 based on context it is used

func (*OpenapiListProjectsRespItemsItems0) MarshalBinary 

func (m *OpenapiListProjectsRespItemsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProjectsRespItemsItems0) UnmarshalBinary 

func (m *OpenapiListProjectsRespItemsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProjectsRespItemsItems0) Validate 

func (m *OpenapiListProjectsRespItemsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list projects resp items items0

type OpenapiListProviderRegionsItem 

type OpenapiListProviderRegionsItem struct {

	// The cloud provider on which your TiDB cluster is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// The cluster type.
	// - `"DEVELOPER"`: a [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) cluster
	// - `"DEDICATED"`: a [TiDB Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#dedicated-tier) cluster
	//
	// **Warning:** `"DEVELOPER"` will soon be changed to `"SERVERLESS"` to represent TiDB Serverless clusters.
	// Example: DEDICATED
	// Enum: [DEDICATED DEVELOPER]
	ClusterType string `json:"cluster_type,omitempty"`

	// The region in which your TiDB cluster is hosted.
	//
	// For the detailed information on each region, refer to the documentation of the corresponding cloud provider ([AWS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) | [GCP](https://cloud.google.com/about/locations#americas)).
	//
	// For example, `"us-west-2"` refers to Oregon for AWS.
	// Example: us-west-2
	Region string `json:"region,omitempty"`

	// The list of TiDB specifications in the region.
	Tidb []*OpenapiListProviderRegionsItemTidbItems0 `json:"tidb"`

	// The list of TiFlash specifications in the region.
	Tiflash []*OpenapiListProviderRegionsItemTiflashItems0 `json:"tiflash"`

	// The list of TiKV specifications in the region.
	Tikv []*OpenapiListProviderRegionsItemTikvItems0 `json:"tikv"`
}

OpenapiListProviderRegionsItem ListProviderRegionsItem

ListProviderRegionsItem is the item of provider regions.

swagger:model openapiListProviderRegionsItem

func (*OpenapiListProviderRegionsItem) ContextValidate 

func (m *OpenapiListProviderRegionsItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions item based on the context it is used

func (*OpenapiListProviderRegionsItem) MarshalBinary 

func (m *OpenapiListProviderRegionsItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItem) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItem) Validate 

func (m *OpenapiListProviderRegionsItem) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item

type OpenapiListProviderRegionsItemTidbItems0 

type OpenapiListProviderRegionsItemTidbItems0 struct {

	// node quantity range
	NodeQuantityRange *OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiDB component in the cluster.
	// Example: 8C16G
	NodeSize string `json:"node_size,omitempty"`
}

OpenapiListProviderRegionsItemTidbItems0 openapi list provider regions item tidb items0

swagger:model OpenapiListProviderRegionsItemTidbItems0

func (*OpenapiListProviderRegionsItemTidbItems0) ContextValidate 

func (m *OpenapiListProviderRegionsItemTidbItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions item tidb items0 based on the context it is used

func (*OpenapiListProviderRegionsItemTidbItems0) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTidbItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTidbItems0) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTidbItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTidbItems0) Validate 

func (m *OpenapiListProviderRegionsItemTidbItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tidb items0

type OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange 

type OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange The range and step of node quantity of the TiDB component in the cluster.

swagger:model OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange

func (*OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) ContextValidate 

func (m *OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions item tidb items0 node quantity range based on context it is used

func (*OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) Validate 

func (m *OpenapiListProviderRegionsItemTidbItems0NodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tidb items0 node quantity range

type OpenapiListProviderRegionsItemTiflashItems0 

type OpenapiListProviderRegionsItemTiflashItems0 struct {

	// node quantity range
	NodeQuantityRange *OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiFlash component in the cluster.
	// Example: 8C64G
	NodeSize string `json:"node_size,omitempty"`

	// storage size gib range
	StorageSizeGibRange *OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange `json:"storage_size_gib_range,omitempty"`
}

OpenapiListProviderRegionsItemTiflashItems0 openapi list provider regions item tiflash items0

swagger:model OpenapiListProviderRegionsItemTiflashItems0

func (*OpenapiListProviderRegionsItemTiflashItems0) ContextValidate 

func (m *OpenapiListProviderRegionsItemTiflashItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions item tiflash items0 based on the context it is used

func (*OpenapiListProviderRegionsItemTiflashItems0) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTiflashItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTiflashItems0) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTiflashItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTiflashItems0) Validate 

func (m *OpenapiListProviderRegionsItemTiflashItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tiflash items0

type OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange 

type OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange The range and step of node quantity of the TiFlash component in the cluster.

swagger:model OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange

func (*OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) ContextValidate 

func (m *OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions item tiflash items0 node quantity range based on context it is used

func (*OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) Validate 

func (m *OpenapiListProviderRegionsItemTiflashItems0NodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tiflash items0 node quantity range

type OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange 

type OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange struct {

	// The maximum storage size for each node of the component in the cluster.
	Max int32 `json:"max,omitempty"`

	// The minimum storage size for each node of the component in the cluster.
	Min int32 `json:"min,omitempty"`
}

OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange The storage size range for each node of the TiFlash component in the cluster.

swagger:model OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange

func (*OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) ContextValidate 

func (m *OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions item tiflash items0 storage size gib range based on context it is used

func (*OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) Validate 

func (m *OpenapiListProviderRegionsItemTiflashItems0StorageSizeGibRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tiflash items0 storage size gib range

type OpenapiListProviderRegionsItemTikvItems0 

type OpenapiListProviderRegionsItemTikvItems0 struct {

	// node quantity range
	NodeQuantityRange *OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiKV component in the cluster.
	// Example: 8C32G
	NodeSize string `json:"node_size,omitempty"`

	// storage size gib range
	StorageSizeGibRange *OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange `json:"storage_size_gib_range,omitempty"`
}

OpenapiListProviderRegionsItemTikvItems0 openapi list provider regions item tikv items0

swagger:model OpenapiListProviderRegionsItemTikvItems0

func (*OpenapiListProviderRegionsItemTikvItems0) ContextValidate 

func (m *OpenapiListProviderRegionsItemTikvItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions item tikv items0 based on the context it is used

func (*OpenapiListProviderRegionsItemTikvItems0) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTikvItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTikvItems0) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTikvItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTikvItems0) Validate 

func (m *OpenapiListProviderRegionsItemTikvItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tikv items0

type OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange 

type OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange The range and step of node quantity of the TiKV component in the cluster.

swagger:model OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange

func (*OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) ContextValidate 

func (m *OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions item tikv items0 node quantity range based on context it is used

func (*OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) Validate 

func (m *OpenapiListProviderRegionsItemTikvItems0NodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tikv items0 node quantity range

type OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange 

type OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange struct {

	// The maximum storage size for each node of the component in the cluster.
	Max int32 `json:"max,omitempty"`

	// The minimum storage size for each node of the component in the cluster.
	Min int32 `json:"min,omitempty"`
}

OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange The storage size range for each node of the TiKV component in the cluster.

swagger:model OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange

func (*OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) ContextValidate 

func (m *OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions item tikv items0 storage size gib range based on context it is used

func (*OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) MarshalBinary 

func (m *OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) Validate 

func (m *OpenapiListProviderRegionsItemTikvItems0StorageSizeGibRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions item tikv items0 storage size gib range

type OpenapiListProviderRegionsResp 

type OpenapiListProviderRegionsResp struct {

	// Items of provider regions.
	// Example: [{"cloud_provider":"AWS","cluster_type":"DEDICATED","region":"us-west-2","tidb":[{"node_quantity_range":{"min":1,"step":1},"node_size":"8C16G"}],"tiflash":[{"node_quantity_range":{"min":0,"step":1},"node_size":"8C64G","storage_size_gib_range":{"max":2048,"min":500}}],"tikv":[{"node_quantity_range":{"min":3,"step":3},"node_size":"8C32G","storage_size_gib_range":{"max":4096,"min":500}}]},{"cloud_provider":"AWS","cluster_type":"DEVELOPER","region":"us-west-2","tidb":[{"node_quantity_range":{"min":1,"step":1},"node_size":"Shared0"}],"tiflash":[{"node_quantity_range":{"min":1,"step":1},"node_size":"Shared0","storage_size_gib_range":{"max":1,"min":1}}],"tikv":[{"node_quantity_range":{"min":1,"step":1},"node_size":"Shared0","storage_size_gib_range":{"max":1,"min":1}}]}]
	Items []*OpenapiListProviderRegionsRespItemsItems0 `json:"items"`
}

OpenapiListProviderRegionsResp GetProviderRegionsResp

GetProviderRegionsResp is the response for getting provider regions.

swagger:model openapiListProviderRegionsResp

func (*OpenapiListProviderRegionsResp) ContextValidate 

func (m *OpenapiListProviderRegionsResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions resp based on the context it is used

func (*OpenapiListProviderRegionsResp) MarshalBinary 

func (m *OpenapiListProviderRegionsResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsResp) UnmarshalBinary 

func (m *OpenapiListProviderRegionsResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsResp) Validate 

func (m *OpenapiListProviderRegionsResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp

type OpenapiListProviderRegionsRespItemsItems0 

type OpenapiListProviderRegionsRespItemsItems0 struct {

	// The cloud provider on which your TiDB cluster is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// The cluster type.
	// - `"DEVELOPER"`: a [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) cluster
	// - `"DEDICATED"`: a [TiDB Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#dedicated-tier) cluster
	//
	// **Warning:** `"DEVELOPER"` will soon be changed to `"SERVERLESS"` to represent TiDB Serverless clusters.
	// Example: DEDICATED
	// Enum: [DEDICATED DEVELOPER]
	ClusterType string `json:"cluster_type,omitempty"`

	// The region in which your TiDB cluster is hosted.
	//
	// For the detailed information on each region, refer to the documentation of the corresponding cloud provider ([AWS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) | [GCP](https://cloud.google.com/about/locations#americas)).
	//
	// For example, `"us-west-2"` refers to Oregon for AWS.
	// Example: us-west-2
	Region string `json:"region,omitempty"`

	// The list of TiDB specifications in the region.
	Tidb []*OpenapiListProviderRegionsRespItemsItems0TidbItems0 `json:"tidb"`

	// The list of TiFlash specifications in the region.
	Tiflash []*OpenapiListProviderRegionsRespItemsItems0TiflashItems0 `json:"tiflash"`

	// The list of TiKV specifications in the region.
	Tikv []*OpenapiListProviderRegionsRespItemsItems0TikvItems0 `json:"tikv"`
}

OpenapiListProviderRegionsRespItemsItems0 ListProviderRegionsItem

ListProviderRegionsItem is the item of provider regions.

swagger:model OpenapiListProviderRegionsRespItemsItems0

func (*OpenapiListProviderRegionsRespItemsItems0) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions resp items items0 based on the context it is used

func (*OpenapiListProviderRegionsRespItemsItems0) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0

type OpenapiListProviderRegionsRespItemsItems0TidbItems0 

type OpenapiListProviderRegionsRespItemsItems0TidbItems0 struct {

	// node quantity range
	NodeQuantityRange *OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiDB component in the cluster.
	// Example: 8C16G
	NodeSize string `json:"node_size,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TidbItems0 openapi list provider regions resp items items0 tidb items0

swagger:model OpenapiListProviderRegionsRespItemsItems0TidbItems0

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions resp items items0 tidb items0 based on the context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tidb items0

type OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange 

type OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange The range and step of node quantity of the TiDB component in the cluster.

swagger:model OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions resp items items0 tidb items0 node quantity range based on context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TidbItems0NodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tidb items0 node quantity range

type OpenapiListProviderRegionsRespItemsItems0TiflashItems0 

type OpenapiListProviderRegionsRespItemsItems0TiflashItems0 struct {

	// node quantity range
	NodeQuantityRange *OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiFlash component in the cluster.
	// Example: 8C64G
	NodeSize string `json:"node_size,omitempty"`

	// storage size gib range
	StorageSizeGibRange *OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange `json:"storage_size_gib_range,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TiflashItems0 openapi list provider regions resp items items0 tiflash items0

swagger:model OpenapiListProviderRegionsRespItemsItems0TiflashItems0

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions resp items items0 tiflash items0 based on the context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tiflash items0

type OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange 

type OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange The range and step of node quantity of the TiFlash component in the cluster.

swagger:model OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions resp items items0 tiflash items0 node quantity range based on context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0NodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tiflash items0 node quantity range

type OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange 

type OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange struct {

	// The maximum storage size for each node of the component in the cluster.
	Max int32 `json:"max,omitempty"`

	// The minimum storage size for each node of the component in the cluster.
	Min int32 `json:"min,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange The storage size range for each node of the TiFlash component in the cluster.

swagger:model OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions resp items items0 tiflash items0 storage size gib range based on context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TiflashItems0StorageSizeGibRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tiflash items0 storage size gib range

type OpenapiListProviderRegionsRespItemsItems0TikvItems0 

type OpenapiListProviderRegionsRespItemsItems0TikvItems0 struct {

	// node quantity range
	NodeQuantityRange *OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiKV component in the cluster.
	// Example: 8C32G
	NodeSize string `json:"node_size,omitempty"`

	// storage size gib range
	StorageSizeGibRange *OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange `json:"storage_size_gib_range,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TikvItems0 openapi list provider regions resp items items0 tikv items0

swagger:model OpenapiListProviderRegionsRespItemsItems0TikvItems0

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list provider regions resp items items0 tikv items0 based on the context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tikv items0

type OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange 

type OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange The range and step of node quantity of the TiKV component in the cluster.

swagger:model OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions resp items items0 tikv items0 node quantity range based on context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0NodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tikv items0 node quantity range

type OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange 

type OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange struct {

	// The maximum storage size for each node of the component in the cluster.
	Max int32 `json:"max,omitempty"`

	// The minimum storage size for each node of the component in the cluster.
	Min int32 `json:"min,omitempty"`
}

OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange The storage size range for each node of the TiKV component in the cluster.

swagger:model OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) ContextValidate 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list provider regions resp items items0 tikv items0 storage size gib range based on context it is used

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) MarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) UnmarshalBinary 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) Validate 

func (m *OpenapiListProviderRegionsRespItemsItems0TikvItems0StorageSizeGibRange) Validate(formats strfmt.Registry) error

Validate validates this openapi list provider regions resp items items0 tikv items0 storage size gib range

type OpenapiListRestoreOfProjectResp 

type OpenapiListRestoreOfProjectResp struct {

	// The items of all restore tasks.
	Items []*OpenapiListRestoreOfProjectRespItemsItems0 `json:"items"`

	// The total number of restore tasks in the project.
	// Example: 10
	Total int64 `json:"total,omitempty"`
}

OpenapiListRestoreOfProjectResp ListRestoreResp

This response for list restore.

swagger:model openapiListRestoreOfProjectResp

func (*OpenapiListRestoreOfProjectResp) ContextValidate 

func (m *OpenapiListRestoreOfProjectResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list restore of project resp based on the context it is used

func (*OpenapiListRestoreOfProjectResp) MarshalBinary 

func (m *OpenapiListRestoreOfProjectResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListRestoreOfProjectResp) UnmarshalBinary 

func (m *OpenapiListRestoreOfProjectResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListRestoreOfProjectResp) Validate 

func (m *OpenapiListRestoreOfProjectResp) Validate(formats strfmt.Registry) error

Validate validates this openapi list restore of project resp

type OpenapiListRestoreOfProjectRespItemsItems0 

type OpenapiListRestoreOfProjectRespItemsItems0 struct {

	// The ID of the backup.
	// Example: 1
	BackupID string `json:"backup_id,omitempty"`

	// cluster
	Cluster *OpenapiListRestoreOfProjectRespItemsItems0Cluster `json:"cluster,omitempty"`

	// The cluster ID of the backup.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// The creation time of the backup in UTC.
	//
	// The time format follows the [ISO8601](http://en.wikipedia.org/wiki/ISO_8601) standard, which is `YYYY-MM-DD` (year-month-day) + T +`HH:MM:SS` (hour-minutes-seconds) + Z. For example, `2020-01-01T00:00:00Z`.
	// Example: 2020-01-01T00:00:00Z
	// Format: date-time
	CreateTimestamp strfmt.DateTime `json:"create_timestamp,omitempty"`

	// The error message of restore if failed.
	// Example: Please contact support.
	ErrorMessage string `json:"error_message,omitempty"`

	// The ID of the restore task.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The status of the restore task.
	// Example: PENDING
	// Enum: [PENDING RUNNING FAILED SUCCESS]
	Status string `json:"status,omitempty"`
}

OpenapiListRestoreOfProjectRespItemsItems0 ListRestoreRespItem

The items of all restore tasks.

swagger:model OpenapiListRestoreOfProjectRespItemsItems0

func (*OpenapiListRestoreOfProjectRespItemsItems0) ContextValidate 

func (m *OpenapiListRestoreOfProjectRespItemsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list restore of project resp items items0 based on the context it is used

func (*OpenapiListRestoreOfProjectRespItemsItems0) MarshalBinary 

func (m *OpenapiListRestoreOfProjectRespItemsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListRestoreOfProjectRespItemsItems0) UnmarshalBinary 

func (m *OpenapiListRestoreOfProjectRespItemsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListRestoreOfProjectRespItemsItems0) Validate 

func (m *OpenapiListRestoreOfProjectRespItemsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi list restore of project resp items items0

type OpenapiListRestoreOfProjectRespItemsItems0Cluster 

type OpenapiListRestoreOfProjectRespItemsItems0Cluster struct {

	// The ID of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: cluster-1
	Name string `json:"name,omitempty"`

	// The status of the restored cluster. Possible values are `"AVAILABLE"`, `"CREATING"`, `"MODIFYING"`, `"PAUSED"`, `"RESUMING"`, `"UNAVAILABLE"`, `"IMPORTING"`, and `"CLEARED"`.
	// Example: AVAILABLE
	Status string `json:"status,omitempty"`
}

OpenapiListRestoreOfProjectRespItemsItems0Cluster ClusterInfoOfRestore

The information of the restored cluster. The restored cluster is the new cluster your backup data is restored to.

swagger:model OpenapiListRestoreOfProjectRespItemsItems0Cluster

func (*OpenapiListRestoreOfProjectRespItemsItems0Cluster) ContextValidate 

func (m *OpenapiListRestoreOfProjectRespItemsItems0Cluster) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list restore of project resp items items0 cluster based on context it is used

func (*OpenapiListRestoreOfProjectRespItemsItems0Cluster) MarshalBinary 

func (m *OpenapiListRestoreOfProjectRespItemsItems0Cluster) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListRestoreOfProjectRespItemsItems0Cluster) UnmarshalBinary 

func (m *OpenapiListRestoreOfProjectRespItemsItems0Cluster) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListRestoreOfProjectRespItemsItems0Cluster) Validate 

func (m *OpenapiListRestoreOfProjectRespItemsItems0Cluster) Validate(formats strfmt.Registry) error

Validate validates this openapi list restore of project resp items items0 cluster

type OpenapiListRestoreRespItem 

type OpenapiListRestoreRespItem struct {

	// The ID of the backup.
	// Example: 1
	BackupID string `json:"backup_id,omitempty"`

	// cluster
	Cluster *OpenapiListRestoreRespItemCluster `json:"cluster,omitempty"`

	// The cluster ID of the backup.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// The creation time of the backup in UTC.
	//
	// The time format follows the [ISO8601](http://en.wikipedia.org/wiki/ISO_8601) standard, which is `YYYY-MM-DD` (year-month-day) + T +`HH:MM:SS` (hour-minutes-seconds) + Z. For example, `2020-01-01T00:00:00Z`.
	// Example: 2020-01-01T00:00:00Z
	// Format: date-time
	CreateTimestamp strfmt.DateTime `json:"create_timestamp,omitempty"`

	// The error message of restore if failed.
	// Example: Please contact support.
	ErrorMessage string `json:"error_message,omitempty"`

	// The ID of the restore task.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The status of the restore task.
	// Example: PENDING
	// Enum: [PENDING RUNNING FAILED SUCCESS]
	Status string `json:"status,omitempty"`
}

OpenapiListRestoreRespItem ListRestoreRespItem

The items of all restore tasks.

swagger:model openapiListRestoreRespItem

func (*OpenapiListRestoreRespItem) ContextValidate 

func (m *OpenapiListRestoreRespItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi list restore resp item based on the context it is used

func (*OpenapiListRestoreRespItem) MarshalBinary 

func (m *OpenapiListRestoreRespItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListRestoreRespItem) UnmarshalBinary 

func (m *OpenapiListRestoreRespItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListRestoreRespItem) Validate 

func (m *OpenapiListRestoreRespItem) Validate(formats strfmt.Registry) error

Validate validates this openapi list restore resp item

type OpenapiListRestoreRespItemCluster 

type OpenapiListRestoreRespItemCluster struct {

	// The ID of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: 1
	ID string `json:"id,omitempty"`

	// The name of the restored cluster. The restored cluster is the new cluster your backup data is restored to.
	// Example: cluster-1
	Name string `json:"name,omitempty"`

	// The status of the restored cluster. Possible values are `"AVAILABLE"`, `"CREATING"`, `"MODIFYING"`, `"PAUSED"`, `"RESUMING"`, `"UNAVAILABLE"`, `"IMPORTING"`, and `"CLEARED"`.
	// Example: AVAILABLE
	Status string `json:"status,omitempty"`
}

OpenapiListRestoreRespItemCluster ClusterInfoOfRestore

The information of the restored cluster. The restored cluster is the new cluster your backup data is restored to.

swagger:model OpenapiListRestoreRespItemCluster

func (*OpenapiListRestoreRespItemCluster) ContextValidate 

func (m *OpenapiListRestoreRespItemCluster) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list restore resp item cluster based on context it is used

func (*OpenapiListRestoreRespItemCluster) MarshalBinary 

func (m *OpenapiListRestoreRespItemCluster) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiListRestoreRespItemCluster) UnmarshalBinary 

func (m *OpenapiListRestoreRespItemCluster) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiListRestoreRespItemCluster) Validate 

func (m *OpenapiListRestoreRespItemCluster) Validate(formats strfmt.Registry) error

Validate validates this openapi list restore resp item cluster

type OpenapiListRestoreRespItemStatusEnum 

type OpenapiListRestoreRespItemStatusEnum string

OpenapiListRestoreRespItemStatusEnum openapi list restore resp item status enum

swagger:model openapiListRestoreRespItemStatusEnum 

const (

	// OpenapiListRestoreRespItemStatusEnumPENDING captures enum value "PENDING"
	OpenapiListRestoreRespItemStatusEnumPENDING OpenapiListRestoreRespItemStatusEnum = "PENDING"

	// OpenapiListRestoreRespItemStatusEnumRUNNING captures enum value "RUNNING"
	OpenapiListRestoreRespItemStatusEnumRUNNING OpenapiListRestoreRespItemStatusEnum = "RUNNING"

	// OpenapiListRestoreRespItemStatusEnumFAILED captures enum value "FAILED"
	OpenapiListRestoreRespItemStatusEnumFAILED OpenapiListRestoreRespItemStatusEnum = "FAILED"

	// OpenapiListRestoreRespItemStatusEnumSUCCESS captures enum value "SUCCESS"
	OpenapiListRestoreRespItemStatusEnumSUCCESS OpenapiListRestoreRespItemStatusEnum = "SUCCESS"
)

func NewOpenapiListRestoreRespItemStatusEnum 

func NewOpenapiListRestoreRespItemStatusEnum(value OpenapiListRestoreRespItemStatusEnum) *OpenapiListRestoreRespItemStatusEnum

func (OpenapiListRestoreRespItemStatusEnum) ContextValidate 

func (m OpenapiListRestoreRespItemStatusEnum) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi list restore resp item status enum based on context it is used

func (OpenapiListRestoreRespItemStatusEnum) Pointer 

func (m OpenapiListRestoreRespItemStatusEnum) Pointer() *OpenapiListRestoreRespItemStatusEnum

Pointer returns a pointer to a freshly-allocated OpenapiListRestoreRespItemStatusEnum.

func (OpenapiListRestoreRespItemStatusEnum) Validate 

func (m OpenapiListRestoreRespItemStatusEnum) Validate(formats strfmt.Registry) error

Validate validates this openapi list restore resp item status enum

type OpenapiLocalFilePayload 

type OpenapiLocalFilePayload struct {

	// The base64-encoded content of the local file to be imported. The maximum size of the file should be 52428800 (50 MiB).
	//
	// **Note:** Before providing the content, process the file by taking the following steps:
	// 1. Compress the file using the **gzip** algorithm.
	// 2. Encode the compressed data using the **base64** algorithm.
	// Example: H4sIABbP9mMAAyXHOwoAIQwFwN5jvPoh5neggI2w9Z7fSJqBOZt/fvLQIURmLgFlrqE9BbVmPQOt5j0HvRa9AKN2AUwss6dTAAAA
	// Required: true
	// Max Length: 52428800
	// Format: byte
	Content *strfmt.Base64 `json:"content"`

	// The total size of the **ACTUAL** local file contents, not the total size of the `content` field.
	//
	// The unit is byte, and the maximum value is `52428800` (50 MiB). If the given value of `total_size_bytes` exceeds the maximum value, an error will be reported.
	// Example: 83
	// Required: true
	TotalSizeBytes *string `json:"total_size_bytes"`
}

OpenapiLocalFilePayload LocalFilePayload

LocalFilePayload represents the payload to upload a local file content for importing.

swagger:model openapiLocalFilePayload

func (*OpenapiLocalFilePayload) ContextValidate 

func (m *OpenapiLocalFilePayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi local file payload based on context it is used

func (*OpenapiLocalFilePayload) MarshalBinary 

func (m *OpenapiLocalFilePayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiLocalFilePayload) UnmarshalBinary 

func (m *OpenapiLocalFilePayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiLocalFilePayload) Validate 

func (m *OpenapiLocalFilePayload) Validate(formats strfmt.Registry) error

Validate validates this openapi local file payload

type OpenapiNodeQuantityRange 

type OpenapiNodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiNodeQuantityRange openapi node quantity range

swagger:model openapiNodeQuantityRange

func (*OpenapiNodeQuantityRange) ContextValidate 

func (m *OpenapiNodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi node quantity range based on context it is used

func (*OpenapiNodeQuantityRange) MarshalBinary 

func (m *OpenapiNodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiNodeQuantityRange) UnmarshalBinary 

func (m *OpenapiNodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiNodeQuantityRange) Validate 

func (m *OpenapiNodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi node quantity range

type OpenapiNodeStatus 

type OpenapiNodeStatus string

OpenapiNodeStatus openapi node status

swagger:model openapiNodeStatus 

const (

	// OpenapiNodeStatusNODESTATUSAVAILABLE captures enum value "NODE_STATUS_AVAILABLE"
	OpenapiNodeStatusNODESTATUSAVAILABLE OpenapiNodeStatus = "NODE_STATUS_AVAILABLE"

	// OpenapiNodeStatusNODESTATUSUNAVAILABLE captures enum value "NODE_STATUS_UNAVAILABLE"
	OpenapiNodeStatusNODESTATUSUNAVAILABLE OpenapiNodeStatus = "NODE_STATUS_UNAVAILABLE"

	// OpenapiNodeStatusNODESTATUSCREATING captures enum value "NODE_STATUS_CREATING"
	OpenapiNodeStatusNODESTATUSCREATING OpenapiNodeStatus = "NODE_STATUS_CREATING"

	// OpenapiNodeStatusNODESTATUSDELETING captures enum value "NODE_STATUS_DELETING"
	OpenapiNodeStatusNODESTATUSDELETING OpenapiNodeStatus = "NODE_STATUS_DELETING"
)

func NewOpenapiNodeStatus 

func NewOpenapiNodeStatus(value OpenapiNodeStatus) *OpenapiNodeStatus

func (OpenapiNodeStatus) ContextValidate 

func (m OpenapiNodeStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi node status based on context it is used

func (OpenapiNodeStatus) Pointer 

func (m OpenapiNodeStatus) Pointer() *OpenapiNodeStatus

Pointer returns a pointer to a freshly-allocated OpenapiNodeStatus.

func (OpenapiNodeStatus) Validate 

func (m OpenapiNodeStatus) Validate(formats strfmt.Registry) error

Validate validates this openapi node status

type OpenapiNodeStorageSizeRange 

type OpenapiNodeStorageSizeRange struct {

	// The maximum storage size for each node of the component in the cluster.
	Max int32 `json:"max,omitempty"`

	// The minimum storage size for each node of the component in the cluster.
	Min int32 `json:"min,omitempty"`
}

OpenapiNodeStorageSizeRange openapi node storage size range

swagger:model openapiNodeStorageSizeRange

func (*OpenapiNodeStorageSizeRange) ContextValidate 

func (m *OpenapiNodeStorageSizeRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi node storage size range based on context it is used

func (*OpenapiNodeStorageSizeRange) MarshalBinary 

func (m *OpenapiNodeStorageSizeRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiNodeStorageSizeRange) UnmarshalBinary 

func (m *OpenapiNodeStorageSizeRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiNodeStorageSizeRange) Validate 

func (m *OpenapiNodeStorageSizeRange) Validate(formats strfmt.Registry) error

Validate validates this openapi node storage size range

type OpenapiPreviewImportDataResp 

type OpenapiPreviewImportDataResp struct {

	// The preview results for each target table from the import task specification.
	TablePreviews []*OpenapiPreviewImportDataRespTablePreviewsItems0 `json:"table_previews"`
}

OpenapiPreviewImportDataResp PreviewImportDataResp

PreviewImportDataResp is the response of the source data preview before starting an import task.

swagger:model openapiPreviewImportDataResp

func (*OpenapiPreviewImportDataResp) ContextValidate 

func (m *OpenapiPreviewImportDataResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi preview import data resp based on the context it is used

func (*OpenapiPreviewImportDataResp) MarshalBinary 

func (m *OpenapiPreviewImportDataResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPreviewImportDataResp) UnmarshalBinary 

func (m *OpenapiPreviewImportDataResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPreviewImportDataResp) Validate 

func (m *OpenapiPreviewImportDataResp) Validate(formats strfmt.Registry) error

Validate validates this openapi preview import data resp

type OpenapiPreviewImportDataRespTablePreviewsItems0 

type OpenapiPreviewImportDataRespTablePreviewsItems0 struct {

	// data preview
	// Required: true
	DataPreview *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview `json:"data_preview"`

	// The database name of the preview table.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// schema preview
	SchemaPreview *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview `json:"schema_preview,omitempty"`

	// The table name of the preview table.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiPreviewImportDataRespTablePreviewsItems0 TablePreview

TablePreview is the preview result for a single table.

swagger:model OpenapiPreviewImportDataRespTablePreviewsItems0

func (*OpenapiPreviewImportDataRespTablePreviewsItems0) ContextValidate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi preview import data resp table previews items0 based on the context it is used

func (*OpenapiPreviewImportDataRespTablePreviewsItems0) MarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0) UnmarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0) Validate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi preview import data resp table previews items0

type OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview 

type OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview struct {

	// The column names for the following data samples from a table.
	// Example: ["id","column01"]
	ColumnNames []string `json:"column_names"`

	// The rows sampled from a table.
	// Required: true
	Rows []*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0 `json:"rows"`
}

OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview TableData

The data sample for the preview table.

swagger:model OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) ContextValidate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi preview import data resp table previews items0 data preview based on the context it is used

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) MarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) UnmarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) Validate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreview) Validate(formats strfmt.Registry) error

Validate validates this openapi preview import data resp table previews items0 data preview

type OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0 

type OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0 struct {

	// The columns extracted from a table row.
	// Example: ["1","abc"]
	// Required: true
	Columns []string `json:"columns"`
}

OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0 TableDataRow

TableDataRow is a single row in a table.

swagger:model OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) ContextValidate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi preview import data resp table previews items0 data preview rows items0 based on context it is used

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) MarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) UnmarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) Validate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0DataPreviewRowsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi preview import data resp table previews items0 data preview rows items0

type OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview 

type OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview struct {

	// The column definition for each column in the table.
	// Example: [{"column_name":"id","column_type":"INTEGER"},{"column_name":"column01","column_type":"VARCHAR(255)"}]
	// Required: true
	ColumnDefinitions []*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0 `json:"column_definitions"`

	// The primary key column names for the table. This is optional. The primary key is taken into account when the table is pre-created before an import task is started.
	// Example: ["id"]
	PrimaryKeyColumns []string `json:"primary_key_columns"`
}

OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview TableSchema

The schema for the preview table.

swagger:model OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) ContextValidate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi preview import data resp table previews items0 schema preview based on the context it is used

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) MarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) UnmarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) Validate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreview) Validate(formats strfmt.Registry) error

Validate validates this openapi preview import data resp table previews items0 schema preview

type OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0 

type OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0 struct {

	// The column name.
	// Example: column01
	// Required: true
	ColumnName *string `json:"column_name"`

	// The column type.
	// Example: VARCHAR(255)
	// Required: true
	ColumnType *string `json:"column_type"`
}

OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0 ColumnDefinition

ColumnDefinition is the definition of a column in a table.

swagger:model OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) ContextValidate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi preview import data resp table previews items0 schema preview column definitions items0 based on context it is used

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) MarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) UnmarshalBinary 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) Validate 

func (m *OpenapiPreviewImportDataRespTablePreviewsItems0SchemaPreviewColumnDefinitionsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi preview import data resp table previews items0 schema preview column definitions items0

type OpenapiPrivateEndpoint 

type OpenapiPrivateEndpoint struct {

	// [Output Only] The cloud provider on which the private endpoint service is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// [Output Only] The ID of the cluster.
	// Example: 1
	ClusterID string `json:"cluster_id,omitempty"`

	// [Output Only] The name of the cluster.
	// Example: Cluster0
	ClusterName string `json:"cluster_name,omitempty"`

	// The format of the private endpoint name varies by cloud provider: `"vpce-xxxx"` for AWS and `"projects/xxx/regions/xxx/forwardingRules/xxx"` for Google Cloud.
	// Example: vpce-01234567890123456
	EndpointName string `json:"endpoint_name,omitempty"`

	// [Output Only] The ID of private endpoint. It is used when you [deleting the endpoint](#tag/Cluster/operation/DeletePrivateEndpoint).
	// Example: 1
	ID string `json:"id,omitempty"`

	// [Output Only] The detailed message when the `status` is "FAILED".
	// Example: The endpoint does not exist.
	Message string `json:"message,omitempty"`

	// [Output Only] The region where the private endpoint is hosted, such as Oregon in AWS.
	// Example: Oregon
	RegionName string `json:"region_name,omitempty"`

	// [Output Only] The service name of the private endpoint.
	// Example: com.amazonaws.vpce.us-west-2.vpce-svc-01234567890123456
	ServiceName string `json:"service_name,omitempty"`

	// [Output Only] The status of the private endpoint service.
	// Example: ACTIVE
	// Enum: [CREATING ACTIVE DELETING]
	ServiceStatus string `json:"service_status,omitempty"`

	// [Output Only] The status of the private endpoint.
	// Example: FAILED
	// Enum: [PENDING ACTIVE DELETING FAILED]
	Status string `json:"status,omitempty"`
}

OpenapiPrivateEndpoint openapi private endpoint

swagger:model openapiPrivateEndpoint

func (*OpenapiPrivateEndpoint) ContextValidate 

func (m *OpenapiPrivateEndpoint) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi private endpoint based on context it is used

func (*OpenapiPrivateEndpoint) MarshalBinary 

func (m *OpenapiPrivateEndpoint) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPrivateEndpoint) UnmarshalBinary 

func (m *OpenapiPrivateEndpoint) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPrivateEndpoint) Validate 

func (m *OpenapiPrivateEndpoint) Validate(formats strfmt.Registry) error

Validate validates this openapi private endpoint

type OpenapiPrivateEndpointService 

type OpenapiPrivateEndpointService struct {

	// Availability zones for the private endpoint service. This field is only applicable when the `cloud_provider` is `"AWS"`.
	// Example: ["usw2-az2","usw2-az1"]
	AzIds []string `json:"az_ids"`

	// The cloud provider on which the private endpoint service is hosted.
	// - `"AWS"`: the Amazon Web Services cloud provider
	// - `"GCP"`: the Google Cloud cloud provider
	// Example: AWS
	// Enum: [AWS GCP]
	CloudProvider string `json:"cloud_provider,omitempty"`

	// The DNS name of the private endpoint service.
	// Example: privatelink-tidb.01234567890.clusters.tidb-cloud.com
	DNSName string `json:"dns_name,omitempty"`

	// The name of the private endpoint service, which is used for connection.
	// Example: com.amazonaws.vpce.us-west-2.vpce-svc-01234567890123456
	Name string `json:"name,omitempty"`

	// The port of the private endpoint service.
	// Example: 4000
	Port int32 `json:"port,omitempty"`

	// The status of the private endpoint service.
	// Example: ACTIVE
	// Enum: [CREATING ACTIVE DELETING]
	Status string `json:"status,omitempty"`
}

OpenapiPrivateEndpointService openapi private endpoint service

swagger:model openapiPrivateEndpointService

func (*OpenapiPrivateEndpointService) ContextValidate 

func (m *OpenapiPrivateEndpointService) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi private endpoint service based on context it is used

func (*OpenapiPrivateEndpointService) MarshalBinary 

func (m *OpenapiPrivateEndpointService) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiPrivateEndpointService) UnmarshalBinary 

func (m *OpenapiPrivateEndpointService) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiPrivateEndpointService) Validate 

func (m *OpenapiPrivateEndpointService) Validate(formats strfmt.Registry) error

Validate validates this openapi private endpoint service

type OpenapiPrivateEndpointServiceStatus 

type OpenapiPrivateEndpointServiceStatus string

OpenapiPrivateEndpointServiceStatus openapi private endpoint service status

swagger:model openapiPrivateEndpointServiceStatus 

const (

	// OpenapiPrivateEndpointServiceStatusCREATING captures enum value "CREATING"
	OpenapiPrivateEndpointServiceStatusCREATING OpenapiPrivateEndpointServiceStatus = "CREATING"

	// OpenapiPrivateEndpointServiceStatusACTIVE captures enum value "ACTIVE"
	OpenapiPrivateEndpointServiceStatusACTIVE OpenapiPrivateEndpointServiceStatus = "ACTIVE"

	// OpenapiPrivateEndpointServiceStatusDELETING captures enum value "DELETING"
	OpenapiPrivateEndpointServiceStatusDELETING OpenapiPrivateEndpointServiceStatus = "DELETING"
)

func NewOpenapiPrivateEndpointServiceStatus 

func NewOpenapiPrivateEndpointServiceStatus(value OpenapiPrivateEndpointServiceStatus) *OpenapiPrivateEndpointServiceStatus

func (OpenapiPrivateEndpointServiceStatus) ContextValidate 

func (m OpenapiPrivateEndpointServiceStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi private endpoint service status based on context it is used

func (OpenapiPrivateEndpointServiceStatus) Pointer 

func (m OpenapiPrivateEndpointServiceStatus) Pointer() *OpenapiPrivateEndpointServiceStatus

Pointer returns a pointer to a freshly-allocated OpenapiPrivateEndpointServiceStatus.

func (OpenapiPrivateEndpointServiceStatus) Validate 

func (m OpenapiPrivateEndpointServiceStatus) Validate(formats strfmt.Registry) error

Validate validates this openapi private endpoint service status

type OpenapiPrivateEndpointStatus 

type OpenapiPrivateEndpointStatus string

OpenapiPrivateEndpointStatus openapi private endpoint status

swagger:model openapiPrivateEndpointStatus 

const (

	// OpenapiPrivateEndpointStatusPENDING captures enum value "PENDING"
	OpenapiPrivateEndpointStatusPENDING OpenapiPrivateEndpointStatus = "PENDING"

	// OpenapiPrivateEndpointStatusACTIVE captures enum value "ACTIVE"
	OpenapiPrivateEndpointStatusACTIVE OpenapiPrivateEndpointStatus = "ACTIVE"

	// OpenapiPrivateEndpointStatusDELETING captures enum value "DELETING"
	OpenapiPrivateEndpointStatusDELETING OpenapiPrivateEndpointStatus = "DELETING"

	// OpenapiPrivateEndpointStatusFAILED captures enum value "FAILED"
	OpenapiPrivateEndpointStatusFAILED OpenapiPrivateEndpointStatus = "FAILED"
)

func NewOpenapiPrivateEndpointStatus 

func NewOpenapiPrivateEndpointStatus(value OpenapiPrivateEndpointStatus) *OpenapiPrivateEndpointStatus

func (OpenapiPrivateEndpointStatus) ContextValidate 

func (m OpenapiPrivateEndpointStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi private endpoint status based on context it is used

func (OpenapiPrivateEndpointStatus) Pointer 

func (m OpenapiPrivateEndpointStatus) Pointer() *OpenapiPrivateEndpointStatus

Pointer returns a pointer to a freshly-allocated OpenapiPrivateEndpointStatus.

func (OpenapiPrivateEndpointStatus) Validate 

func (m OpenapiPrivateEndpointStatus) Validate(formats strfmt.Registry) error

Validate validates this openapi private endpoint status

type OpenapiStandardConnection 

type OpenapiStandardConnection struct {

	// The host of standard connection.
	// Example: tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiStandardConnection openapi standard connection

swagger:model openapiStandardConnection

func (*OpenapiStandardConnection) ContextValidate 

func (m *OpenapiStandardConnection) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi standard connection based on context it is used

func (*OpenapiStandardConnection) MarshalBinary 

func (m *OpenapiStandardConnection) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiStandardConnection) UnmarshalBinary 

func (m *OpenapiStandardConnection) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiStandardConnection) Validate 

func (m *OpenapiStandardConnection) Validate(formats strfmt.Registry) error

Validate validates this openapi standard connection

type OpenapiTableData 

type OpenapiTableData struct {

	// The column names for the following data samples from a table.
	// Example: ["id","column01"]
	ColumnNames []string `json:"column_names"`

	// The rows sampled from a table.
	// Required: true
	Rows []*OpenapiTableDataRowsItems0 `json:"rows"`
}

OpenapiTableData TableData

TableData represents some data samples from a table.

swagger:model openapiTableData

func (*OpenapiTableData) ContextValidate 

func (m *OpenapiTableData) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi table data based on the context it is used

func (*OpenapiTableData) MarshalBinary 

func (m *OpenapiTableData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableData) UnmarshalBinary 

func (m *OpenapiTableData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableData) Validate 

func (m *OpenapiTableData) Validate(formats strfmt.Registry) error

Validate validates this openapi table data

type OpenapiTableDataRow 

type OpenapiTableDataRow struct {

	// The columns extracted from a table row.
	// Example: ["1","abc"]
	// Required: true
	Columns []string `json:"columns"`
}

OpenapiTableDataRow TableDataRow

TableDataRow is a single row in a table.

swagger:model openapiTableDataRow

func (*OpenapiTableDataRow) ContextValidate 

func (m *OpenapiTableDataRow) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi table data row based on context it is used

func (*OpenapiTableDataRow) MarshalBinary 

func (m *OpenapiTableDataRow) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableDataRow) UnmarshalBinary 

func (m *OpenapiTableDataRow) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableDataRow) Validate 

func (m *OpenapiTableDataRow) Validate(formats strfmt.Registry) error

Validate validates this openapi table data row

type OpenapiTableDataRowsItems0 

type OpenapiTableDataRowsItems0 struct {

	// The columns extracted from a table row.
	// Example: ["1","abc"]
	// Required: true
	Columns []string `json:"columns"`
}

OpenapiTableDataRowsItems0 TableDataRow

TableDataRow is a single row in a table.

swagger:model OpenapiTableDataRowsItems0

func (*OpenapiTableDataRowsItems0) ContextValidate 

func (m *OpenapiTableDataRowsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi table data rows items0 based on context it is used

func (*OpenapiTableDataRowsItems0) MarshalBinary 

func (m *OpenapiTableDataRowsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableDataRowsItems0) UnmarshalBinary 

func (m *OpenapiTableDataRowsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableDataRowsItems0) Validate 

func (m *OpenapiTableDataRowsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi table data rows items0

type OpenapiTableDefinition 

type OpenapiTableDefinition struct {

	// The database name of the table.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// schema
	// Required: true
	Schema *OpenapiTableDefinitionSchema `json:"schema"`

	// The table name of the table.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiTableDefinition TableDefinition

TableDefinition is the definition of a table so that the table can be created with this information.

swagger:model openapiTableDefinition

func (*OpenapiTableDefinition) ContextValidate 

func (m *OpenapiTableDefinition) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi table definition based on the context it is used

func (*OpenapiTableDefinition) MarshalBinary 

func (m *OpenapiTableDefinition) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableDefinition) UnmarshalBinary 

func (m *OpenapiTableDefinition) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableDefinition) Validate 

func (m *OpenapiTableDefinition) Validate(formats strfmt.Registry) error

Validate validates this openapi table definition

type OpenapiTableDefinitionSchema 

type OpenapiTableDefinitionSchema struct {

	// The column definition for each column in the table.
	// Example: [{"column_name":"id","column_type":"INTEGER"},{"column_name":"column01","column_type":"VARCHAR(255)"}]
	// Required: true
	ColumnDefinitions []*OpenapiTableDefinitionSchemaColumnDefinitionsItems0 `json:"column_definitions"`

	// The primary key column names for the table. This is optional. The primary key is taken into account when the table is pre-created before an import task is started.
	// Example: ["id"]
	PrimaryKeyColumns []string `json:"primary_key_columns"`
}

OpenapiTableDefinitionSchema TableSchema

The schema for the table.

swagger:model OpenapiTableDefinitionSchema

func (*OpenapiTableDefinitionSchema) ContextValidate 

func (m *OpenapiTableDefinitionSchema) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi table definition schema based on the context it is used

func (*OpenapiTableDefinitionSchema) MarshalBinary 

func (m *OpenapiTableDefinitionSchema) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableDefinitionSchema) UnmarshalBinary 

func (m *OpenapiTableDefinitionSchema) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableDefinitionSchema) Validate 

func (m *OpenapiTableDefinitionSchema) Validate(formats strfmt.Registry) error

Validate validates this openapi table definition schema

type OpenapiTableDefinitionSchemaColumnDefinitionsItems0 

type OpenapiTableDefinitionSchemaColumnDefinitionsItems0 struct {

	// The column name.
	// Example: column01
	// Required: true
	ColumnName *string `json:"column_name"`

	// The column type.
	// Example: VARCHAR(255)
	// Required: true
	ColumnType *string `json:"column_type"`
}

OpenapiTableDefinitionSchemaColumnDefinitionsItems0 ColumnDefinition

ColumnDefinition is the definition of a column in a table.

swagger:model OpenapiTableDefinitionSchemaColumnDefinitionsItems0

func (*OpenapiTableDefinitionSchemaColumnDefinitionsItems0) ContextValidate 

func (m *OpenapiTableDefinitionSchemaColumnDefinitionsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi table definition schema column definitions items0 based on context it is used

func (*OpenapiTableDefinitionSchemaColumnDefinitionsItems0) MarshalBinary 

func (m *OpenapiTableDefinitionSchemaColumnDefinitionsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableDefinitionSchemaColumnDefinitionsItems0) UnmarshalBinary 

func (m *OpenapiTableDefinitionSchemaColumnDefinitionsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableDefinitionSchemaColumnDefinitionsItems0) Validate 

func (m *OpenapiTableDefinitionSchemaColumnDefinitionsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi table definition schema column definitions items0

type OpenapiTablePreview 

type OpenapiTablePreview struct {

	// data preview
	// Required: true
	DataPreview *OpenapiTablePreviewDataPreview `json:"data_preview"`

	// The database name of the preview table.
	// Example: db01
	// Required: true
	DatabaseName *string `json:"database_name"`

	// schema preview
	SchemaPreview *OpenapiTablePreviewSchemaPreview `json:"schema_preview,omitempty"`

	// The table name of the preview table.
	// Example: table01
	// Required: true
	TableName *string `json:"table_name"`
}

OpenapiTablePreview TablePreview

TablePreview is the preview result for a single table.

swagger:model openapiTablePreview

func (*OpenapiTablePreview) ContextValidate 

func (m *OpenapiTablePreview) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi table preview based on the context it is used

func (*OpenapiTablePreview) MarshalBinary 

func (m *OpenapiTablePreview) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTablePreview) UnmarshalBinary 

func (m *OpenapiTablePreview) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTablePreview) Validate 

func (m *OpenapiTablePreview) Validate(formats strfmt.Registry) error

Validate validates this openapi table preview

type OpenapiTablePreviewDataPreview 

type OpenapiTablePreviewDataPreview struct {

	// The column names for the following data samples from a table.
	// Example: ["id","column01"]
	ColumnNames []string `json:"column_names"`

	// The rows sampled from a table.
	// Required: true
	Rows []*OpenapiTablePreviewDataPreviewRowsItems0 `json:"rows"`
}

OpenapiTablePreviewDataPreview TableData

The data sample for the preview table.

swagger:model OpenapiTablePreviewDataPreview

func (*OpenapiTablePreviewDataPreview) ContextValidate 

func (m *OpenapiTablePreviewDataPreview) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi table preview data preview based on the context it is used

func (*OpenapiTablePreviewDataPreview) MarshalBinary 

func (m *OpenapiTablePreviewDataPreview) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTablePreviewDataPreview) UnmarshalBinary 

func (m *OpenapiTablePreviewDataPreview) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTablePreviewDataPreview) Validate 

func (m *OpenapiTablePreviewDataPreview) Validate(formats strfmt.Registry) error

Validate validates this openapi table preview data preview

type OpenapiTablePreviewDataPreviewRowsItems0 

type OpenapiTablePreviewDataPreviewRowsItems0 struct {

	// The columns extracted from a table row.
	// Example: ["1","abc"]
	// Required: true
	Columns []string `json:"columns"`
}

OpenapiTablePreviewDataPreviewRowsItems0 TableDataRow

TableDataRow is a single row in a table.

swagger:model OpenapiTablePreviewDataPreviewRowsItems0

func (*OpenapiTablePreviewDataPreviewRowsItems0) ContextValidate 

func (m *OpenapiTablePreviewDataPreviewRowsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi table preview data preview rows items0 based on context it is used

func (*OpenapiTablePreviewDataPreviewRowsItems0) MarshalBinary 

func (m *OpenapiTablePreviewDataPreviewRowsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTablePreviewDataPreviewRowsItems0) UnmarshalBinary 

func (m *OpenapiTablePreviewDataPreviewRowsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTablePreviewDataPreviewRowsItems0) Validate 

func (m *OpenapiTablePreviewDataPreviewRowsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi table preview data preview rows items0

type OpenapiTablePreviewSchemaPreview 

type OpenapiTablePreviewSchemaPreview struct {

	// The column definition for each column in the table.
	// Example: [{"column_name":"id","column_type":"INTEGER"},{"column_name":"column01","column_type":"VARCHAR(255)"}]
	// Required: true
	ColumnDefinitions []*OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0 `json:"column_definitions"`

	// The primary key column names for the table. This is optional. The primary key is taken into account when the table is pre-created before an import task is started.
	// Example: ["id"]
	PrimaryKeyColumns []string `json:"primary_key_columns"`
}

OpenapiTablePreviewSchemaPreview TableSchema

The schema for the preview table.

swagger:model OpenapiTablePreviewSchemaPreview

func (*OpenapiTablePreviewSchemaPreview) ContextValidate 

func (m *OpenapiTablePreviewSchemaPreview) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi table preview schema preview based on the context it is used

func (*OpenapiTablePreviewSchemaPreview) MarshalBinary 

func (m *OpenapiTablePreviewSchemaPreview) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTablePreviewSchemaPreview) UnmarshalBinary 

func (m *OpenapiTablePreviewSchemaPreview) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTablePreviewSchemaPreview) Validate 

func (m *OpenapiTablePreviewSchemaPreview) Validate(formats strfmt.Registry) error

Validate validates this openapi table preview schema preview

type OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0 

type OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0 struct {

	// The column name.
	// Example: column01
	// Required: true
	ColumnName *string `json:"column_name"`

	// The column type.
	// Example: VARCHAR(255)
	// Required: true
	ColumnType *string `json:"column_type"`
}

OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0 ColumnDefinition

ColumnDefinition is the definition of a column in a table.

swagger:model OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0

func (*OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) ContextValidate 

func (m *OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi table preview schema preview column definitions items0 based on context it is used

func (*OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) MarshalBinary 

func (m *OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) UnmarshalBinary 

func (m *OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) Validate 

func (m *OpenapiTablePreviewSchemaPreviewColumnDefinitionsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi table preview schema preview column definitions items0

type OpenapiTableSchema 

type OpenapiTableSchema struct {

	// The column definition for each column in the table.
	// Example: [{"column_name":"id","column_type":"INTEGER"},{"column_name":"column01","column_type":"VARCHAR(255)"}]
	// Required: true
	ColumnDefinitions []*OpenapiTableSchemaColumnDefinitionsItems0 `json:"column_definitions"`

	// The primary key column names for the table. This is optional. The primary key is taken into account when the table is pre-created before an import task is started.
	// Example: ["id"]
	PrimaryKeyColumns []string `json:"primary_key_columns"`
}

OpenapiTableSchema TableSchema

TableSchema is the schema definition of a single table.

swagger:model openapiTableSchema

func (*OpenapiTableSchema) ContextValidate 

func (m *OpenapiTableSchema) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi table schema based on the context it is used

func (*OpenapiTableSchema) MarshalBinary 

func (m *OpenapiTableSchema) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableSchema) UnmarshalBinary 

func (m *OpenapiTableSchema) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableSchema) Validate 

func (m *OpenapiTableSchema) Validate(formats strfmt.Registry) error

Validate validates this openapi table schema

type OpenapiTableSchemaColumnDefinitionsItems0 

type OpenapiTableSchemaColumnDefinitionsItems0 struct {

	// The column name.
	// Example: column01
	// Required: true
	ColumnName *string `json:"column_name"`

	// The column type.
	// Example: VARCHAR(255)
	// Required: true
	ColumnType *string `json:"column_type"`
}

OpenapiTableSchemaColumnDefinitionsItems0 ColumnDefinition

ColumnDefinition is the definition of a column in a table.

swagger:model OpenapiTableSchemaColumnDefinitionsItems0

func (*OpenapiTableSchemaColumnDefinitionsItems0) ContextValidate 

func (m *OpenapiTableSchemaColumnDefinitionsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi table schema column definitions items0 based on context it is used

func (*OpenapiTableSchemaColumnDefinitionsItems0) MarshalBinary 

func (m *OpenapiTableSchemaColumnDefinitionsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTableSchemaColumnDefinitionsItems0) UnmarshalBinary 

func (m *OpenapiTableSchemaColumnDefinitionsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTableSchemaColumnDefinitionsItems0) Validate 

func (m *OpenapiTableSchemaColumnDefinitionsItems0) Validate(formats strfmt.Registry) error

Validate validates this openapi table schema column definitions items0

type OpenapiTiDBComponent 

type OpenapiTiDBComponent struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 2
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C16G
	// Required: true
	NodeSize *string `json:"node_size"`
}

OpenapiTiDBComponent openapi ti d b component

swagger:model openapiTiDBComponent

func (*OpenapiTiDBComponent) ContextValidate 

func (m *OpenapiTiDBComponent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti d b component based on context it is used

func (*OpenapiTiDBComponent) MarshalBinary 

func (m *OpenapiTiDBComponent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiDBComponent) UnmarshalBinary 

func (m *OpenapiTiDBComponent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiDBComponent) Validate 

func (m *OpenapiTiDBComponent) Validate(formats strfmt.Registry) error

Validate validates this openapi ti d b component

type OpenapiTiDBNodeMap 

type OpenapiTiDBNodeMap struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tidb-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiDB component in the cluster.
	// Example: 8C16G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 17179869184
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiTiDBNodeMap openapi ti d b node map

swagger:model openapiTiDBNodeMap

func (*OpenapiTiDBNodeMap) ContextValidate 

func (m *OpenapiTiDBNodeMap) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti d b node map based on context it is used

func (*OpenapiTiDBNodeMap) MarshalBinary 

func (m *OpenapiTiDBNodeMap) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiDBNodeMap) UnmarshalBinary 

func (m *OpenapiTiDBNodeMap) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiDBNodeMap) Validate 

func (m *OpenapiTiDBNodeMap) Validate(formats strfmt.Registry) error

Validate validates this openapi ti d b node map

type OpenapiTiDBProfile 

type OpenapiTiDBProfile struct {

	// node quantity range
	NodeQuantityRange *OpenapiTiDBProfileNodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiDB component in the cluster.
	// Example: 8C16G
	NodeSize string `json:"node_size,omitempty"`
}

OpenapiTiDBProfile openapi ti d b profile

swagger:model openapiTiDBProfile

func (*OpenapiTiDBProfile) ContextValidate 

func (m *OpenapiTiDBProfile) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi ti d b profile based on the context it is used

func (*OpenapiTiDBProfile) MarshalBinary 

func (m *OpenapiTiDBProfile) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiDBProfile) UnmarshalBinary 

func (m *OpenapiTiDBProfile) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiDBProfile) Validate 

func (m *OpenapiTiDBProfile) Validate(formats strfmt.Registry) error

Validate validates this openapi ti d b profile

type OpenapiTiDBProfileNodeQuantityRange 

type OpenapiTiDBProfileNodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiTiDBProfileNodeQuantityRange The range and step of node quantity of the TiDB component in the cluster.

swagger:model OpenapiTiDBProfileNodeQuantityRange

func (*OpenapiTiDBProfileNodeQuantityRange) ContextValidate 

func (m *OpenapiTiDBProfileNodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti d b profile node quantity range based on context it is used

func (*OpenapiTiDBProfileNodeQuantityRange) MarshalBinary 

func (m *OpenapiTiDBProfileNodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiDBProfileNodeQuantityRange) UnmarshalBinary 

func (m *OpenapiTiDBProfileNodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiDBProfileNodeQuantityRange) Validate 

func (m *OpenapiTiDBProfileNodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi ti d b profile node quantity range

type OpenapiTiFlashComponent 

type OpenapiTiFlashComponent struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiTiFlashComponent openapi ti flash component

swagger:model openapiTiFlashComponent

func (*OpenapiTiFlashComponent) ContextValidate 

func (m *OpenapiTiFlashComponent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti flash component based on context it is used

func (*OpenapiTiFlashComponent) MarshalBinary 

func (m *OpenapiTiFlashComponent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiFlashComponent) UnmarshalBinary 

func (m *OpenapiTiFlashComponent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiFlashComponent) Validate 

func (m *OpenapiTiFlashComponent) Validate(formats strfmt.Registry) error

Validate validates this openapi ti flash component

type OpenapiTiFlashNodeMap 

type OpenapiTiFlashNodeMap struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tiflash-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiFlash component in the cluster.
	// Example: 8C64G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiTiFlashNodeMap openapi ti flash node map

swagger:model openapiTiFlashNodeMap

func (*OpenapiTiFlashNodeMap) ContextValidate 

func (m *OpenapiTiFlashNodeMap) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti flash node map based on context it is used

func (*OpenapiTiFlashNodeMap) MarshalBinary 

func (m *OpenapiTiFlashNodeMap) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiFlashNodeMap) UnmarshalBinary 

func (m *OpenapiTiFlashNodeMap) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiFlashNodeMap) Validate 

func (m *OpenapiTiFlashNodeMap) Validate(formats strfmt.Registry) error

Validate validates this openapi ti flash node map

type OpenapiTiFlashProfile 

type OpenapiTiFlashProfile struct {

	// node quantity range
	NodeQuantityRange *OpenapiTiFlashProfileNodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiFlash component in the cluster.
	// Example: 8C64G
	NodeSize string `json:"node_size,omitempty"`

	// storage size gib range
	StorageSizeGibRange *OpenapiTiFlashProfileStorageSizeGibRange `json:"storage_size_gib_range,omitempty"`
}

OpenapiTiFlashProfile openapi ti flash profile

swagger:model openapiTiFlashProfile

func (*OpenapiTiFlashProfile) ContextValidate 

func (m *OpenapiTiFlashProfile) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi ti flash profile based on the context it is used

func (*OpenapiTiFlashProfile) MarshalBinary 

func (m *OpenapiTiFlashProfile) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiFlashProfile) UnmarshalBinary 

func (m *OpenapiTiFlashProfile) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiFlashProfile) Validate 

func (m *OpenapiTiFlashProfile) Validate(formats strfmt.Registry) error

Validate validates this openapi ti flash profile

type OpenapiTiFlashProfileNodeQuantityRange 

type OpenapiTiFlashProfileNodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiTiFlashProfileNodeQuantityRange The range and step of node quantity of the TiFlash component in the cluster.

swagger:model OpenapiTiFlashProfileNodeQuantityRange

func (*OpenapiTiFlashProfileNodeQuantityRange) ContextValidate 

func (m *OpenapiTiFlashProfileNodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti flash profile node quantity range based on context it is used

func (*OpenapiTiFlashProfileNodeQuantityRange) MarshalBinary 

func (m *OpenapiTiFlashProfileNodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiFlashProfileNodeQuantityRange) UnmarshalBinary 

func (m *OpenapiTiFlashProfileNodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiFlashProfileNodeQuantityRange) Validate 

func (m *OpenapiTiFlashProfileNodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi ti flash profile node quantity range

type OpenapiTiFlashProfileStorageSizeGibRange 

type OpenapiTiFlashProfileStorageSizeGibRange struct {

	// The maximum storage size for each node of the component in the cluster.
	Max int32 `json:"max,omitempty"`

	// The minimum storage size for each node of the component in the cluster.
	Min int32 `json:"min,omitempty"`
}

OpenapiTiFlashProfileStorageSizeGibRange The storage size range for each node of the TiFlash component in the cluster.

swagger:model OpenapiTiFlashProfileStorageSizeGibRange

func (*OpenapiTiFlashProfileStorageSizeGibRange) ContextValidate 

func (m *OpenapiTiFlashProfileStorageSizeGibRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti flash profile storage size gib range based on context it is used

func (*OpenapiTiFlashProfileStorageSizeGibRange) MarshalBinary 

func (m *OpenapiTiFlashProfileStorageSizeGibRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiFlashProfileStorageSizeGibRange) UnmarshalBinary 

func (m *OpenapiTiFlashProfileStorageSizeGibRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiFlashProfileStorageSizeGibRange) Validate 

func (m *OpenapiTiFlashProfileStorageSizeGibRange) Validate(formats strfmt.Registry) error

Validate validates this openapi ti flash profile storage size gib range

type OpenapiTiKVComponent 

type OpenapiTiKVComponent struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 3
	// Required: true
	NodeQuantity *int32 `json:"node_quantity"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	// Example: 8C64G
	// Required: true
	NodeSize *string `json:"node_size"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 1024
	// Required: true
	StorageSizeGib *int32 `json:"storage_size_gib"`
}

OpenapiTiKVComponent openapi ti k v component

swagger:model openapiTiKVComponent

func (*OpenapiTiKVComponent) ContextValidate 

func (m *OpenapiTiKVComponent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti k v component based on context it is used

func (*OpenapiTiKVComponent) MarshalBinary 

func (m *OpenapiTiKVComponent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiKVComponent) UnmarshalBinary 

func (m *OpenapiTiKVComponent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiKVComponent) Validate 

func (m *OpenapiTiKVComponent) Validate(formats strfmt.Registry) error

Validate validates this openapi ti k v component

type OpenapiTiKVNodeMap 

type OpenapiTiKVNodeMap struct {

	// The availability zone of a node in the cluster.
	// Example: us-west-2a
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of a node in the cluster.
	// Example: tikv-0
	NodeName string `json:"node_name,omitempty"`

	// The size of the TiKV component in the cluster.
	// Example: 8C32G
	NodeSize string `json:"node_size,omitempty"`

	// The RAM size of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `ram_bytes` is always 0.
	// Example: 68719476736
	RAMBytes string `json:"ram_bytes,omitempty"`

	// The status of a node in the cluster.
	// Example: NODE_STATUS_AVAILABLE
	// Enum: [NODE_STATUS_AVAILABLE NODE_STATUS_UNAVAILABLE NODE_STATUS_CREATING NODE_STATUS_DELETING]
	Status string `json:"status,omitempty"`

	// The storage size of a node in the cluster.
	// Example: 1024
	StorageSizeGib int32 `json:"storage_size_gib,omitempty"`

	// The total vCPUs of a node in the cluster. If the `cluster_type` is `"DEVELOPER"`, `vcpu_num` is always 0.
	// Example: 8
	VcpuNum int32 `json:"vcpu_num,omitempty"`
}

OpenapiTiKVNodeMap openapi ti k v node map

swagger:model openapiTiKVNodeMap

func (*OpenapiTiKVNodeMap) ContextValidate 

func (m *OpenapiTiKVNodeMap) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti k v node map based on context it is used

func (*OpenapiTiKVNodeMap) MarshalBinary 

func (m *OpenapiTiKVNodeMap) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiKVNodeMap) UnmarshalBinary 

func (m *OpenapiTiKVNodeMap) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiKVNodeMap) Validate 

func (m *OpenapiTiKVNodeMap) Validate(formats strfmt.Registry) error

Validate validates this openapi ti k v node map

type OpenapiTiKVProfile 

type OpenapiTiKVProfile struct {

	// node quantity range
	NodeQuantityRange *OpenapiTiKVProfileNodeQuantityRange `json:"node_quantity_range,omitempty"`

	// The size of the TiKV component in the cluster.
	// Example: 8C32G
	NodeSize string `json:"node_size,omitempty"`

	// storage size gib range
	StorageSizeGibRange *OpenapiTiKVProfileStorageSizeGibRange `json:"storage_size_gib_range,omitempty"`
}

OpenapiTiKVProfile openapi ti k v profile

swagger:model openapiTiKVProfile

func (*OpenapiTiKVProfile) ContextValidate 

func (m *OpenapiTiKVProfile) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi ti k v profile based on the context it is used

func (*OpenapiTiKVProfile) MarshalBinary 

func (m *OpenapiTiKVProfile) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiKVProfile) UnmarshalBinary 

func (m *OpenapiTiKVProfile) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiKVProfile) Validate 

func (m *OpenapiTiKVProfile) Validate(formats strfmt.Registry) error

Validate validates this openapi ti k v profile

type OpenapiTiKVProfileNodeQuantityRange 

type OpenapiTiKVProfileNodeQuantityRange struct {

	// The minimum node quantity of the component in the cluster.
	Min int32 `json:"min,omitempty"`

	// The step of node quantity of the component in the cluster.
	Step int32 `json:"step,omitempty"`
}

OpenapiTiKVProfileNodeQuantityRange The range and step of node quantity of the TiKV component in the cluster.

swagger:model OpenapiTiKVProfileNodeQuantityRange

func (*OpenapiTiKVProfileNodeQuantityRange) ContextValidate 

func (m *OpenapiTiKVProfileNodeQuantityRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti k v profile node quantity range based on context it is used

func (*OpenapiTiKVProfileNodeQuantityRange) MarshalBinary 

func (m *OpenapiTiKVProfileNodeQuantityRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiKVProfileNodeQuantityRange) UnmarshalBinary 

func (m *OpenapiTiKVProfileNodeQuantityRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiKVProfileNodeQuantityRange) Validate 

func (m *OpenapiTiKVProfileNodeQuantityRange) Validate(formats strfmt.Registry) error

Validate validates this openapi ti k v profile node quantity range

type OpenapiTiKVProfileStorageSizeGibRange 

type OpenapiTiKVProfileStorageSizeGibRange struct {

	// The maximum storage size for each node of the component in the cluster.
	Max int32 `json:"max,omitempty"`

	// The minimum storage size for each node of the component in the cluster.
	Min int32 `json:"min,omitempty"`
}

OpenapiTiKVProfileStorageSizeGibRange The storage size range for each node of the TiKV component in the cluster.

swagger:model OpenapiTiKVProfileStorageSizeGibRange

func (*OpenapiTiKVProfileStorageSizeGibRange) ContextValidate 

func (m *OpenapiTiKVProfileStorageSizeGibRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi ti k v profile storage size gib range based on context it is used

func (*OpenapiTiKVProfileStorageSizeGibRange) MarshalBinary 

func (m *OpenapiTiKVProfileStorageSizeGibRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiTiKVProfileStorageSizeGibRange) UnmarshalBinary 

func (m *OpenapiTiKVProfileStorageSizeGibRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiTiKVProfileStorageSizeGibRange) Validate 

func (m *OpenapiTiKVProfileStorageSizeGibRange) Validate(formats strfmt.Registry) error

Validate validates this openapi ti k v profile storage size gib range

type OpenapiUpdateClusterComponents 

type OpenapiUpdateClusterComponents struct {

	// tidb
	Tidb *OpenapiUpdateClusterComponentsTidb `json:"tidb,omitempty"`

	// tiflash
	Tiflash *OpenapiUpdateClusterComponentsTiflash `json:"tiflash,omitempty"`

	// tikv
	Tikv *OpenapiUpdateClusterComponentsTikv `json:"tikv,omitempty"`
}

OpenapiUpdateClusterComponents openapi update cluster components

swagger:model openapiUpdateClusterComponents

func (*OpenapiUpdateClusterComponents) ContextValidate 

func (m *OpenapiUpdateClusterComponents) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi update cluster components based on the context it is used

func (*OpenapiUpdateClusterComponents) MarshalBinary 

func (m *OpenapiUpdateClusterComponents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterComponents) UnmarshalBinary 

func (m *OpenapiUpdateClusterComponents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterComponents) Validate 

func (m *OpenapiUpdateClusterComponents) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster components

type OpenapiUpdateClusterComponentsTidb 

type OpenapiUpdateClusterComponentsTidb struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 3
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C32G
	NodeSize *string `json:"node_size,omitempty"`
}

OpenapiUpdateClusterComponentsTidb The TiDB component of the cluster.

swagger:model OpenapiUpdateClusterComponentsTidb

func (*OpenapiUpdateClusterComponentsTidb) ContextValidate 

func (m *OpenapiUpdateClusterComponentsTidb) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update cluster components tidb based on context it is used

func (*OpenapiUpdateClusterComponentsTidb) MarshalBinary 

func (m *OpenapiUpdateClusterComponentsTidb) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterComponentsTidb) UnmarshalBinary 

func (m *OpenapiUpdateClusterComponentsTidb) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterComponentsTidb) Validate 

func (m *OpenapiUpdateClusterComponentsTidb) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster components tidb

type OpenapiUpdateClusterComponentsTiflash 

type OpenapiUpdateClusterComponentsTiflash struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 2
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C128G
	NodeSize *string `json:"node_size,omitempty"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - You cannot decrease storage size for TiFlash.
	// - If your TiDB cluster is hosted by AWS, after changing the storage size of TiFlash, you must wait at least six hours before you can change it again.
	// Example: 2048
	StorageSizeGib *int32 `json:"storage_size_gib,omitempty"`
}

OpenapiUpdateClusterComponentsTiflash The TiFlash component of the cluster.

If you want to add TiFlash nodes to a cluster that does not have one before (increase the node_quantity of `"TIFLASH"` from 0), you must specify the `node_size`, `storage_size_gib` and `node_quantity` of TiFlash nodes.

swagger:model OpenapiUpdateClusterComponentsTiflash

func (*OpenapiUpdateClusterComponentsTiflash) ContextValidate 

func (m *OpenapiUpdateClusterComponentsTiflash) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update cluster components tiflash based on context it is used

func (*OpenapiUpdateClusterComponentsTiflash) MarshalBinary 

func (m *OpenapiUpdateClusterComponentsTiflash) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterComponentsTiflash) UnmarshalBinary 

func (m *OpenapiUpdateClusterComponentsTiflash) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterComponentsTiflash) Validate 

func (m *OpenapiUpdateClusterComponentsTiflash) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster components tiflash

type OpenapiUpdateClusterComponentsTikv 

type OpenapiUpdateClusterComponentsTikv struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 6
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C64G
	NodeSize *string `json:"node_size,omitempty"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - You cannot decrease storage size for TiKV.
	// - If your TiDB cluster is hosted by AWS, after changing the storage size of TiKV, you must wait at least six hours before you can change it again.
	// Example: 2048
	StorageSizeGib *int32 `json:"storage_size_gib,omitempty"`
}

OpenapiUpdateClusterComponentsTikv The TiKV component of the cluster.

swagger:model OpenapiUpdateClusterComponentsTikv

func (*OpenapiUpdateClusterComponentsTikv) ContextValidate 

func (m *OpenapiUpdateClusterComponentsTikv) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update cluster components tikv based on context it is used

func (*OpenapiUpdateClusterComponentsTikv) MarshalBinary 

func (m *OpenapiUpdateClusterComponentsTikv) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterComponentsTikv) UnmarshalBinary 

func (m *OpenapiUpdateClusterComponentsTikv) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterComponentsTikv) Validate 

func (m *OpenapiUpdateClusterComponentsTikv) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster components tikv

type OpenapiUpdateClusterConfig 

type OpenapiUpdateClusterConfig struct {

	// components
	Components *OpenapiUpdateClusterConfigComponents `json:"components,omitempty"`

	// Flag that indicates whether the cluster is paused. `true` means to pause the cluster, and `false` means to resume the cluster. For more details, refer to [Pause or Resume a TiDB Cluster](https://docs.pingcap.com/tidbcloud/pause-or-resume-tidb-cluster).
	//
	// **Limitations:**
	//  - The cluster can be paused only when the `cluster_status` is `"AVAILABLE"`.
	// - The cluster can be resumed only when the `cluster_status` is `"PAUSED"`.
	Paused *bool `json:"paused,omitempty"`
}

OpenapiUpdateClusterConfig UpdateClusterComponents

UpdateClusterComponents is the request for updating cluster components.

swagger:model openapiUpdateClusterConfig

func (*OpenapiUpdateClusterConfig) ContextValidate 

func (m *OpenapiUpdateClusterConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi update cluster config based on the context it is used

func (*OpenapiUpdateClusterConfig) MarshalBinary 

func (m *OpenapiUpdateClusterConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterConfig) UnmarshalBinary 

func (m *OpenapiUpdateClusterConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterConfig) Validate 

func (m *OpenapiUpdateClusterConfig) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster config

type OpenapiUpdateClusterConfigComponents 

type OpenapiUpdateClusterConfigComponents struct {

	// tidb
	Tidb *OpenapiUpdateClusterConfigComponentsTidb `json:"tidb,omitempty"`

	// tiflash
	Tiflash *OpenapiUpdateClusterConfigComponentsTiflash `json:"tiflash,omitempty"`

	// tikv
	Tikv *OpenapiUpdateClusterConfigComponentsTikv `json:"tikv,omitempty"`
}

OpenapiUpdateClusterConfigComponents The components of the cluster.

swagger:model OpenapiUpdateClusterConfigComponents

func (*OpenapiUpdateClusterConfigComponents) ContextValidate 

func (m *OpenapiUpdateClusterConfigComponents) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this openapi update cluster config components based on the context it is used

func (*OpenapiUpdateClusterConfigComponents) MarshalBinary 

func (m *OpenapiUpdateClusterConfigComponents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponents) UnmarshalBinary 

func (m *OpenapiUpdateClusterConfigComponents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponents) Validate 

func (m *OpenapiUpdateClusterConfigComponents) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster config components

type OpenapiUpdateClusterConfigComponentsTidb 

type OpenapiUpdateClusterConfigComponentsTidb struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 3
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C32G
	NodeSize *string `json:"node_size,omitempty"`
}

OpenapiUpdateClusterConfigComponentsTidb The TiDB component of the cluster.

swagger:model OpenapiUpdateClusterConfigComponentsTidb

func (*OpenapiUpdateClusterConfigComponentsTidb) ContextValidate 

func (m *OpenapiUpdateClusterConfigComponentsTidb) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update cluster config components tidb based on context it is used

func (*OpenapiUpdateClusterConfigComponentsTidb) MarshalBinary 

func (m *OpenapiUpdateClusterConfigComponentsTidb) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponentsTidb) UnmarshalBinary 

func (m *OpenapiUpdateClusterConfigComponentsTidb) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponentsTidb) Validate 

func (m *OpenapiUpdateClusterConfigComponentsTidb) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster config components tidb

type OpenapiUpdateClusterConfigComponentsTiflash 

type OpenapiUpdateClusterConfigComponentsTiflash struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 2
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C128G
	NodeSize *string `json:"node_size,omitempty"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - You cannot decrease storage size for TiFlash.
	// - If your TiDB cluster is hosted by AWS, after changing the storage size of TiFlash, you must wait at least six hours before you can change it again.
	// Example: 2048
	StorageSizeGib *int32 `json:"storage_size_gib,omitempty"`
}

OpenapiUpdateClusterConfigComponentsTiflash The TiFlash component of the cluster.

If you want to add TiFlash nodes to a cluster that does not have one before (increase the node_quantity of `"TIFLASH"` from 0), you must specify the `node_size`, `storage_size_gib` and `node_quantity` of TiFlash nodes.

swagger:model OpenapiUpdateClusterConfigComponentsTiflash

func (*OpenapiUpdateClusterConfigComponentsTiflash) ContextValidate 

func (m *OpenapiUpdateClusterConfigComponentsTiflash) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update cluster config components tiflash based on context it is used

func (*OpenapiUpdateClusterConfigComponentsTiflash) MarshalBinary 

func (m *OpenapiUpdateClusterConfigComponentsTiflash) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponentsTiflash) UnmarshalBinary 

func (m *OpenapiUpdateClusterConfigComponentsTiflash) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponentsTiflash) Validate 

func (m *OpenapiUpdateClusterConfigComponentsTiflash) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster config components tiflash

type OpenapiUpdateClusterConfigComponentsTikv 

type OpenapiUpdateClusterConfigComponentsTikv struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 6
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C64G
	NodeSize *string `json:"node_size,omitempty"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - You cannot decrease storage size for TiKV.
	// - If your TiDB cluster is hosted by AWS, after changing the storage size of TiKV, you must wait at least six hours before you can change it again.
	// Example: 2048
	StorageSizeGib *int32 `json:"storage_size_gib,omitempty"`
}

OpenapiUpdateClusterConfigComponentsTikv The TiKV component of the cluster.

swagger:model OpenapiUpdateClusterConfigComponentsTikv

func (*OpenapiUpdateClusterConfigComponentsTikv) ContextValidate 

func (m *OpenapiUpdateClusterConfigComponentsTikv) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update cluster config components tikv based on context it is used

func (*OpenapiUpdateClusterConfigComponentsTikv) MarshalBinary 

func (m *OpenapiUpdateClusterConfigComponentsTikv) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponentsTikv) UnmarshalBinary 

func (m *OpenapiUpdateClusterConfigComponentsTikv) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateClusterConfigComponentsTikv) Validate 

func (m *OpenapiUpdateClusterConfigComponentsTikv) Validate(formats strfmt.Registry) error

Validate validates this openapi update cluster config components tikv

type OpenapiUpdateTiDBComponent 

type OpenapiUpdateTiDBComponent struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 3
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiDB component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C32G
	NodeSize *string `json:"node_size,omitempty"`
}

OpenapiUpdateTiDBComponent openapi update ti d b component

swagger:model openapiUpdateTiDBComponent

func (*OpenapiUpdateTiDBComponent) ContextValidate 

func (m *OpenapiUpdateTiDBComponent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update ti d b component based on context it is used

func (*OpenapiUpdateTiDBComponent) MarshalBinary 

func (m *OpenapiUpdateTiDBComponent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateTiDBComponent) UnmarshalBinary 

func (m *OpenapiUpdateTiDBComponent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateTiDBComponent) Validate 

func (m *OpenapiUpdateTiDBComponent) Validate(formats strfmt.Registry) error

Validate validates this openapi update ti d b component

type OpenapiUpdateTiFlashComponent 

type OpenapiUpdateTiFlashComponent struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	// Example: 2
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiFlash component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C128G
	NodeSize *string `json:"node_size,omitempty"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - You cannot decrease storage size for TiFlash.
	// - If your TiDB cluster is hosted by AWS, after changing the storage size of TiFlash, you must wait at least six hours before you can change it again.
	// Example: 2048
	StorageSizeGib *int32 `json:"storage_size_gib,omitempty"`
}

OpenapiUpdateTiFlashComponent openapi update ti flash component

swagger:model openapiUpdateTiFlashComponent

func (*OpenapiUpdateTiFlashComponent) ContextValidate 

func (m *OpenapiUpdateTiFlashComponent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update ti flash component based on context it is used

func (*OpenapiUpdateTiFlashComponent) MarshalBinary 

func (m *OpenapiUpdateTiFlashComponent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateTiFlashComponent) UnmarshalBinary 

func (m *OpenapiUpdateTiFlashComponent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateTiFlashComponent) Validate 

func (m *OpenapiUpdateTiFlashComponent) Validate(formats strfmt.Registry) error

Validate validates this openapi update ti flash component

type OpenapiUpdateTiKVComponent 

type OpenapiUpdateTiKVComponent struct {

	// The number of nodes in the cluster. You can get the minimum and step of a node quantity from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - The `node_quantity` of TiKV must be a multiple of 3.
	// Example: 6
	NodeQuantity *int32 `json:"node_quantity,omitempty"`

	// The size of the TiKV component in the cluster. You can get the available node size of each region from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Additional combination rules**:
	// - If the vCPUs of TiDB or TiKV component is 4, then their vCPUs need to be the same.
	// - If the vCPUs of TiDB or TiKV component is 4, then the cluster does not support TiFlash.
	//
	// **Limitations**:
	// - See [Change node size](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-node-size).
	// Example: 16C64G
	NodeSize *string `json:"node_size,omitempty"`

	// The storage size of a node in the cluster. You can get the minimum and maximum of storage size from the response of [List the cloud providers, regions and available specifications](#tag/Cluster/operation/ListProviderRegions).
	//
	// **Limitations**:
	// - You cannot decrease storage size for TiKV.
	// - If your TiDB cluster is hosted by AWS, after changing the storage size of TiKV, you must wait at least six hours before you can change it again.
	// Example: 2048
	StorageSizeGib *int32 `json:"storage_size_gib,omitempty"`
}

OpenapiUpdateTiKVComponent openapi update ti k v component

swagger:model openapiUpdateTiKVComponent

func (*OpenapiUpdateTiKVComponent) ContextValidate 

func (m *OpenapiUpdateTiKVComponent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi update ti k v component based on context it is used

func (*OpenapiUpdateTiKVComponent) MarshalBinary 

func (m *OpenapiUpdateTiKVComponent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUpdateTiKVComponent) UnmarshalBinary 

func (m *OpenapiUpdateTiKVComponent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUpdateTiKVComponent) Validate 

func (m *OpenapiUpdateTiKVComponent) Validate(formats strfmt.Registry) error

Validate validates this openapi update ti k v component

type OpenapiUploadLocalFileResp 

type OpenapiUploadLocalFileResp struct {

	// The stub ID for the uploaded file. You can use this stub ID to [create an import task](#tag/Import/operation/CreateImportTask).
	// Example: 123
	// Required: true
	UploadStubID *string `json:"upload_stub_id"`
}

OpenapiUploadLocalFileResp UploadLocalFileResp

UploadLocalFileResp is the response to upload an import task.

swagger:model openapiUploadLocalFileResp

func (*OpenapiUploadLocalFileResp) ContextValidate 

func (m *OpenapiUploadLocalFileResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi upload local file resp based on context it is used

func (*OpenapiUploadLocalFileResp) MarshalBinary 

func (m *OpenapiUploadLocalFileResp) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiUploadLocalFileResp) UnmarshalBinary 

func (m *OpenapiUploadLocalFileResp) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiUploadLocalFileResp) Validate 

func (m *OpenapiUploadLocalFileResp) Validate(formats strfmt.Registry) error

Validate validates this openapi upload local file resp

type OpenapiVPCPeeringConnection 

type OpenapiVPCPeeringConnection struct {

	// The host of VPC peering connection.
	// Example: private-tidb.f69f3808.acea1f2a.us-east-1.shared.aws.tidbcloud.com
	Host string `json:"host,omitempty"`

	// The TiDB port for connection. The port must be in the range of 1024-65535 except 10080.
	//
	// **Limitations**:
	// - For a TiDB Serverless cluster, only port `4000` is available.
	// Example: 4000
	// Maximum: 65535
	// Minimum: 1024
	Port int32 `json:"port,omitempty"`
}

OpenapiVPCPeeringConnection openapi v p c peering connection

swagger:model openapiVPCPeeringConnection

func (*OpenapiVPCPeeringConnection) ContextValidate 

func (m *OpenapiVPCPeeringConnection) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this openapi v p c peering connection based on context it is used

func (*OpenapiVPCPeeringConnection) MarshalBinary 

func (m *OpenapiVPCPeeringConnection) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OpenapiVPCPeeringConnection) UnmarshalBinary 

func (m *OpenapiVPCPeeringConnection) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OpenapiVPCPeeringConnection) Validate 

func (m *OpenapiVPCPeeringConnection) Validate(formats strfmt.Registry) error

Validate validates this openapi v p c peering connection

type ProtobufAny 

type ProtobufAny struct {

	// at type
	AtType string `json:"@type,omitempty"`
}

ProtobufAny protobuf any

swagger:model protobufAny

func (*ProtobufAny) ContextValidate 

func (m *ProtobufAny) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this protobuf any based on context it is used

func (*ProtobufAny) MarshalBinary 

func (m *ProtobufAny) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProtobufAny) UnmarshalBinary 

func (m *ProtobufAny) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProtobufAny) Validate 

func (m *ProtobufAny) Validate(formats strfmt.Registry) error

Validate validates this protobuf any

type RPCStatus 

type RPCStatus struct {

	// code
	Code int32 `json:"code,omitempty"`

	// details
	Details []*RPCStatusDetailsItems0 `json:"details"`

	// message
	Message string `json:"message,omitempty"`
}

RPCStatus rpc status

swagger:model rpcStatus

func (*RPCStatus) ContextValidate 

func (m *RPCStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this rpc status based on the context it is used

func (*RPCStatus) MarshalBinary 

func (m *RPCStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RPCStatus) UnmarshalBinary 

func (m *RPCStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RPCStatus) Validate 

func (m *RPCStatus) Validate(formats strfmt.Registry) error

Validate validates this rpc status

type RPCStatusDetailsItems0 

type RPCStatusDetailsItems0 struct {

	// at type
	AtType string `json:"@type,omitempty"`
}

RPCStatusDetailsItems0 RPC status details items0

swagger:model RPCStatusDetailsItems0

func (*RPCStatusDetailsItems0) ContextValidate 

func (m *RPCStatusDetailsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this RPC status details items0 based on context it is used

func (*RPCStatusDetailsItems0) MarshalBinary 

func (m *RPCStatusDetailsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RPCStatusDetailsItems0) UnmarshalBinary 

func (m *RPCStatusDetailsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RPCStatusDetailsItems0) Validate 

func (m *RPCStatusDetailsItems0) Validate(formats strfmt.Registry) error

Validate validates this RPC status details items0

type UpdateImportTaskReqImportTaskAction 

type UpdateImportTaskReqImportTaskAction string

UpdateImportTaskReqImportTaskAction update import task req import task action

swagger:model UpdateImportTaskReqImportTaskAction 

const (

	// UpdateImportTaskReqImportTaskActionCANCEL captures enum value "CANCEL"
	UpdateImportTaskReqImportTaskActionCANCEL UpdateImportTaskReqImportTaskAction = "CANCEL"
)

func NewUpdateImportTaskReqImportTaskAction 

func NewUpdateImportTaskReqImportTaskAction(value UpdateImportTaskReqImportTaskAction) *UpdateImportTaskReqImportTaskAction

func (UpdateImportTaskReqImportTaskAction) ContextValidate 

func (m UpdateImportTaskReqImportTaskAction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this update import task req import task action based on context it is used

func (UpdateImportTaskReqImportTaskAction) Pointer 

func (m UpdateImportTaskReqImportTaskAction) Pointer() *UpdateImportTaskReqImportTaskAction

Pointer returns a pointer to a freshly-allocated UpdateImportTaskReqImportTaskAction.

func (UpdateImportTaskReqImportTaskAction) Validate 

func (m UpdateImportTaskReqImportTaskAction) Validate(formats strfmt.Registry) error

Validate validates this update import task req import task action

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.