func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAddResourceLockDetailsTypeEnumStringValues() []string
GetAddResourceLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddResourceLockDetailsTypeEnum
func GetAmazonKinesisConnectionTechnologyTypeEnumStringValues() []string
GetAmazonKinesisConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for AmazonKinesisConnectionTechnologyTypeEnum
func GetAmazonRedshiftConnectionTechnologyTypeEnumStringValues() []string
GetAmazonRedshiftConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for AmazonRedshiftConnectionTechnologyTypeEnum
func GetAmazonS3ConnectionTechnologyTypeEnumStringValues() []string
GetAmazonS3ConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for AmazonS3ConnectionTechnologyTypeEnum
func GetAzureDataLakeStorageConnectionAuthenticationTypeEnumStringValues() []string
GetAzureDataLakeStorageConnectionAuthenticationTypeEnumStringValues Enumerates the set of values in String for AzureDataLakeStorageConnectionAuthenticationTypeEnum
func GetAzureDataLakeStorageConnectionTechnologyTypeEnumStringValues() []string
GetAzureDataLakeStorageConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for AzureDataLakeStorageConnectionTechnologyTypeEnum
func GetAzureSynapseConnectionTechnologyTypeEnumStringValues() []string
GetAzureSynapseConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for AzureSynapseConnectionTechnologyTypeEnum
func GetBackupScheduleFrequencyBackupScheduledEnumStringValues() []string
GetBackupScheduleFrequencyBackupScheduledEnumStringValues Enumerates the set of values in String for BackupScheduleFrequencyBackupScheduledEnum
func GetCancelDeploymentBackupTypeEnumStringValues() []string
GetCancelDeploymentBackupTypeEnumStringValues Enumerates the set of values in String for CancelDeploymentBackupTypeEnum
func GetCancelDeploymentUpgradeTypeEnumStringValues() []string
GetCancelDeploymentUpgradeTypeEnumStringValues Enumerates the set of values in String for CancelDeploymentUpgradeTypeEnum
func GetCancelSnoozeDeploymentUpgradeTypeEnumStringValues() []string
GetCancelSnoozeDeploymentUpgradeTypeEnumStringValues Enumerates the set of values in String for CancelSnoozeDeploymentUpgradeTypeEnum
func GetCertificateLifecycleStateEnumStringValues() []string
GetCertificateLifecycleStateEnumStringValues Enumerates the set of values in String for CertificateLifecycleStateEnum
func GetConnectionAssignmentLifecycleStateEnumStringValues() []string
GetConnectionAssignmentLifecycleStateEnumStringValues Enumerates the set of values in String for ConnectionAssignmentLifecycleStateEnum
func GetConnectionLifecycleStateEnumStringValues() []string
GetConnectionLifecycleStateEnumStringValues Enumerates the set of values in String for ConnectionLifecycleStateEnum
func GetConnectionTypeEnumStringValues() []string
GetConnectionTypeEnumStringValues Enumerates the set of values in String for ConnectionTypeEnum
func GetCreateBackupScheduleDetailsFrequencyBackupScheduledEnumStringValues() []string
GetCreateBackupScheduleDetailsFrequencyBackupScheduledEnumStringValues Enumerates the set of values in String for CreateBackupScheduleDetailsFrequencyBackupScheduledEnum
func GetCreateDatabaseRegistrationDetailsSessionModeEnumStringValues() []string
GetCreateDatabaseRegistrationDetailsSessionModeEnumStringValues Enumerates the set of values in String for CreateDatabaseRegistrationDetailsSessionModeEnum
func GetCredentialStoreEnumStringValues() []string
GetCredentialStoreEnumStringValues Enumerates the set of values in String for CredentialStoreEnum
func GetDatabaseRegistrationSessionModeEnumStringValues() []string
GetDatabaseRegistrationSessionModeEnumStringValues Enumerates the set of values in String for DatabaseRegistrationSessionModeEnum
func GetDatabaseRegistrationSummarySessionModeEnumStringValues() []string
GetDatabaseRegistrationSummarySessionModeEnumStringValues Enumerates the set of values in String for DatabaseRegistrationSummarySessionModeEnum
func GetDatabricksConnectionAuthenticationTypeEnumStringValues() []string
GetDatabricksConnectionAuthenticationTypeEnumStringValues Enumerates the set of values in String for DatabricksConnectionAuthenticationTypeEnum
func GetDatabricksConnectionTechnologyTypeEnumStringValues() []string
GetDatabricksConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for DatabricksConnectionTechnologyTypeEnum
func GetDayEnumStringValues() []string
GetDayEnumStringValues Enumerates the set of values in String for DayEnum
func GetDb2ConnectionSecurityProtocolEnumStringValues() []string
GetDb2ConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for Db2ConnectionSecurityProtocolEnum
func GetDb2ConnectionTechnologyTypeEnumStringValues() []string
GetDb2ConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for Db2ConnectionTechnologyTypeEnum
func GetDeploymentBackupBackupSourceTypeEnumStringValues() []string
GetDeploymentBackupBackupSourceTypeEnumStringValues Enumerates the set of values in String for DeploymentBackupBackupSourceTypeEnum
func GetDeploymentBackupSummaryBackupSourceTypeEnumStringValues() []string
GetDeploymentBackupSummaryBackupSourceTypeEnumStringValues Enumerates the set of values in String for DeploymentBackupSummaryBackupSourceTypeEnum
func GetDeploymentBackupTypeEnumStringValues() []string
GetDeploymentBackupTypeEnumStringValues Enumerates the set of values in String for DeploymentBackupTypeEnum
func GetDeploymentCategoryEnumStringValues() []string
GetDeploymentCategoryEnumStringValues Enumerates the set of values in String for DeploymentCategoryEnum
func GetDeploymentDiagnosticStateEnumStringValues() []string
GetDeploymentDiagnosticStateEnumStringValues Enumerates the set of values in String for DeploymentDiagnosticStateEnum
func GetDeploymentTypeEnumStringValues() []string
GetDeploymentTypeEnumStringValues Enumerates the set of values in String for DeploymentTypeEnum
func GetDeploymentUpgradeLifecycleStateEnumStringValues() []string
GetDeploymentUpgradeLifecycleStateEnumStringValues Enumerates the set of values in String for DeploymentUpgradeLifecycleStateEnum
func GetDeploymentUpgradeTypeEnumStringValues() []string
GetDeploymentUpgradeTypeEnumStringValues Enumerates the set of values in String for DeploymentUpgradeTypeEnum
func GetDeploymentWalletOperationTypeEnumStringValues() []string
GetDeploymentWalletOperationTypeEnumStringValues Enumerates the set of values in String for DeploymentWalletOperationTypeEnum
func GetDeploymentWalletStatusEnumStringValues() []string
GetDeploymentWalletStatusEnumStringValues Enumerates the set of values in String for DeploymentWalletStatusEnum
func GetElasticsearchConnectionAuthenticationTypeEnumStringValues() []string
GetElasticsearchConnectionAuthenticationTypeEnumStringValues Enumerates the set of values in String for ElasticsearchConnectionAuthenticationTypeEnum
func GetElasticsearchConnectionSecurityProtocolEnumStringValues() []string
GetElasticsearchConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for ElasticsearchConnectionSecurityProtocolEnum
func GetElasticsearchConnectionTechnologyTypeEnumStringValues() []string
GetElasticsearchConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for ElasticsearchConnectionTechnologyTypeEnum
func GetEnvironmentTypeEnumStringValues() []string
GetEnvironmentTypeEnumStringValues Enumerates the set of values in String for EnvironmentTypeEnum
func GetGenericConnectionTechnologyTypeEnumStringValues() []string
GetGenericConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for GenericConnectionTechnologyTypeEnum
func GetGoldenGateConnectionTechnologyTypeEnumStringValues() []string
GetGoldenGateConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for GoldenGateConnectionTechnologyTypeEnum
func GetGoogleBigQueryConnectionTechnologyTypeEnumStringValues() []string
GetGoogleBigQueryConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for GoogleBigQueryConnectionTechnologyTypeEnum
func GetGoogleCloudStorageConnectionTechnologyTypeEnumStringValues() []string
GetGoogleCloudStorageConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for GoogleCloudStorageConnectionTechnologyTypeEnum
func GetGooglePubSubConnectionTechnologyTypeEnumStringValues() []string
GetGooglePubSubConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for GooglePubSubConnectionTechnologyTypeEnum
func GetHdfsConnectionTechnologyTypeEnumStringValues() []string
GetHdfsConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for HdfsConnectionTechnologyTypeEnum
func GetInitialDataLoadIsInitialLoadEnumStringValues() []string
GetInitialDataLoadIsInitialLoadEnumStringValues Enumerates the set of values in String for InitialDataLoadIsInitialLoadEnum
func GetInitialLoadActionEnumStringValues() []string
GetInitialLoadActionEnumStringValues Enumerates the set of values in String for InitialLoadActionEnum
func GetJavaMessageServiceConnectionAuthenticationTypeEnumStringValues() []string
GetJavaMessageServiceConnectionAuthenticationTypeEnumStringValues Enumerates the set of values in String for JavaMessageServiceConnectionAuthenticationTypeEnum
func GetJavaMessageServiceConnectionSecurityProtocolEnumStringValues() []string
GetJavaMessageServiceConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for JavaMessageServiceConnectionSecurityProtocolEnum
func GetJavaMessageServiceConnectionTechnologyTypeEnumStringValues() []string
GetJavaMessageServiceConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for JavaMessageServiceConnectionTechnologyTypeEnum
func GetKafkaConnectionSecurityProtocolEnumStringValues() []string
GetKafkaConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for KafkaConnectionSecurityProtocolEnum
func GetKafkaConnectionTechnologyTypeEnumStringValues() []string
GetKafkaConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for KafkaConnectionTechnologyTypeEnum
func GetKafkaSchemaRegistryConnectionAuthenticationTypeEnumStringValues() []string
GetKafkaSchemaRegistryConnectionAuthenticationTypeEnumStringValues Enumerates the set of values in String for KafkaSchemaRegistryConnectionAuthenticationTypeEnum
func GetKafkaSchemaRegistryConnectionTechnologyTypeEnumStringValues() []string
GetKafkaSchemaRegistryConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for KafkaSchemaRegistryConnectionTechnologyTypeEnum
func GetLibraryTypeEnumStringValues() []string
GetLibraryTypeEnumStringValues Enumerates the set of values in String for LibraryTypeEnum
func GetLicenseModelEnumStringValues() []string
GetLicenseModelEnumStringValues Enumerates the set of values in String for LicenseModelEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetLifecycleSubStateEnumStringValues() []string
GetLifecycleSubStateEnumStringValues Enumerates the set of values in String for LifecycleSubStateEnum
func GetListCertificatesLifecycleStateEnumStringValues() []string
GetListCertificatesLifecycleStateEnumStringValues Enumerates the set of values in String for ListCertificatesLifecycleStateEnum
func GetListCertificatesSortByEnumStringValues() []string
GetListCertificatesSortByEnumStringValues Enumerates the set of values in String for ListCertificatesSortByEnum
func GetListCertificatesSortOrderEnumStringValues() []string
GetListCertificatesSortOrderEnumStringValues Enumerates the set of values in String for ListCertificatesSortOrderEnum
func GetListConnectionAssignmentsSortByEnumStringValues() []string
GetListConnectionAssignmentsSortByEnumStringValues Enumerates the set of values in String for ListConnectionAssignmentsSortByEnum
func GetListConnectionAssignmentsSortOrderEnumStringValues() []string
GetListConnectionAssignmentsSortOrderEnumStringValues Enumerates the set of values in String for ListConnectionAssignmentsSortOrderEnum
func GetListConnectionsAssignableDeploymentTypeEnumStringValues() []string
GetListConnectionsAssignableDeploymentTypeEnumStringValues Enumerates the set of values in String for ListConnectionsAssignableDeploymentTypeEnum
func GetListConnectionsSortByEnumStringValues() []string
GetListConnectionsSortByEnumStringValues Enumerates the set of values in String for ListConnectionsSortByEnum
func GetListConnectionsSortOrderEnumStringValues() []string
GetListConnectionsSortOrderEnumStringValues Enumerates the set of values in String for ListConnectionsSortOrderEnum
func GetListDatabaseRegistrationsLifecycleStateEnumStringValues() []string
GetListDatabaseRegistrationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDatabaseRegistrationsLifecycleStateEnum
func GetListDatabaseRegistrationsSortByEnumStringValues() []string
GetListDatabaseRegistrationsSortByEnumStringValues Enumerates the set of values in String for ListDatabaseRegistrationsSortByEnum
func GetListDatabaseRegistrationsSortOrderEnumStringValues() []string
GetListDatabaseRegistrationsSortOrderEnumStringValues Enumerates the set of values in String for ListDatabaseRegistrationsSortOrderEnum
func GetListDeploymentBackupsLifecycleStateEnumStringValues() []string
GetListDeploymentBackupsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDeploymentBackupsLifecycleStateEnum
func GetListDeploymentBackupsSortByEnumStringValues() []string
GetListDeploymentBackupsSortByEnumStringValues Enumerates the set of values in String for ListDeploymentBackupsSortByEnum
func GetListDeploymentBackupsSortOrderEnumStringValues() []string
GetListDeploymentBackupsSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentBackupsSortOrderEnum
func GetListDeploymentEnvironmentsSortByEnumStringValues() []string
GetListDeploymentEnvironmentsSortByEnumStringValues Enumerates the set of values in String for ListDeploymentEnvironmentsSortByEnum
func GetListDeploymentEnvironmentsSortOrderEnumStringValues() []string
GetListDeploymentEnvironmentsSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentEnvironmentsSortOrderEnum
func GetListDeploymentTypesDeploymentTypeEnumStringValues() []string
GetListDeploymentTypesDeploymentTypeEnumStringValues Enumerates the set of values in String for ListDeploymentTypesDeploymentTypeEnum
func GetListDeploymentTypesSortByEnumStringValues() []string
GetListDeploymentTypesSortByEnumStringValues Enumerates the set of values in String for ListDeploymentTypesSortByEnum
func GetListDeploymentTypesSortOrderEnumStringValues() []string
GetListDeploymentTypesSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentTypesSortOrderEnum
func GetListDeploymentUpgradesLifecycleStateEnumStringValues() []string
GetListDeploymentUpgradesLifecycleStateEnumStringValues Enumerates the set of values in String for ListDeploymentUpgradesLifecycleStateEnum
func GetListDeploymentUpgradesSortByEnumStringValues() []string
GetListDeploymentUpgradesSortByEnumStringValues Enumerates the set of values in String for ListDeploymentUpgradesSortByEnum
func GetListDeploymentUpgradesSortOrderEnumStringValues() []string
GetListDeploymentUpgradesSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentUpgradesSortOrderEnum
func GetListDeploymentVersionsDeploymentTypeEnumStringValues() []string
GetListDeploymentVersionsDeploymentTypeEnumStringValues Enumerates the set of values in String for ListDeploymentVersionsDeploymentTypeEnum
func GetListDeploymentVersionsSortByEnumStringValues() []string
GetListDeploymentVersionsSortByEnumStringValues Enumerates the set of values in String for ListDeploymentVersionsSortByEnum
func GetListDeploymentVersionsSortOrderEnumStringValues() []string
GetListDeploymentVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentVersionsSortOrderEnum
func GetListDeploymentWalletsOperationsSortByEnumStringValues() []string
GetListDeploymentWalletsOperationsSortByEnumStringValues Enumerates the set of values in String for ListDeploymentWalletsOperationsSortByEnum
func GetListDeploymentWalletsOperationsSortOrderEnumStringValues() []string
GetListDeploymentWalletsOperationsSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentWalletsOperationsSortOrderEnum
func GetListDeploymentsLifecycleStateEnumStringValues() []string
GetListDeploymentsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDeploymentsLifecycleStateEnum
func GetListDeploymentsLifecycleSubStateEnumStringValues() []string
GetListDeploymentsLifecycleSubStateEnumStringValues Enumerates the set of values in String for ListDeploymentsLifecycleSubStateEnum
func GetListDeploymentsSortByEnumStringValues() []string
GetListDeploymentsSortByEnumStringValues Enumerates the set of values in String for ListDeploymentsSortByEnum
func GetListDeploymentsSortOrderEnumStringValues() []string
GetListDeploymentsSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentsSortOrderEnum
func GetListDeploymentsSupportedConnectionTypeEnumStringValues() []string
GetListDeploymentsSupportedConnectionTypeEnumStringValues Enumerates the set of values in String for ListDeploymentsSupportedConnectionTypeEnum
func GetListPipelineRunningProcessesSortByEnumStringValues() []string
GetListPipelineRunningProcessesSortByEnumStringValues Enumerates the set of values in String for ListPipelineRunningProcessesSortByEnum
func GetListPipelineRunningProcessesSortOrderEnumStringValues() []string
GetListPipelineRunningProcessesSortOrderEnumStringValues Enumerates the set of values in String for ListPipelineRunningProcessesSortOrderEnum
func GetListPipelineSchemaTablesSortByEnumStringValues() []string
GetListPipelineSchemaTablesSortByEnumStringValues Enumerates the set of values in String for ListPipelineSchemaTablesSortByEnum
func GetListPipelineSchemaTablesSortOrderEnumStringValues() []string
GetListPipelineSchemaTablesSortOrderEnumStringValues Enumerates the set of values in String for ListPipelineSchemaTablesSortOrderEnum
func GetListPipelineSchemasSortByEnumStringValues() []string
GetListPipelineSchemasSortByEnumStringValues Enumerates the set of values in String for ListPipelineSchemasSortByEnum
func GetListPipelineSchemasSortOrderEnumStringValues() []string
GetListPipelineSchemasSortOrderEnumStringValues Enumerates the set of values in String for ListPipelineSchemasSortOrderEnum
func GetListPipelinesLifecycleSubStateEnumStringValues() []string
GetListPipelinesLifecycleSubStateEnumStringValues Enumerates the set of values in String for ListPipelinesLifecycleSubStateEnum
func GetListPipelinesSortByEnumStringValues() []string
GetListPipelinesSortByEnumStringValues Enumerates the set of values in String for ListPipelinesSortByEnum
func GetListPipelinesSortOrderEnumStringValues() []string
GetListPipelinesSortOrderEnumStringValues Enumerates the set of values in String for ListPipelinesSortOrderEnum
func GetListRecipesRecipeTypeEnumStringValues() []string
GetListRecipesRecipeTypeEnumStringValues Enumerates the set of values in String for ListRecipesRecipeTypeEnum
func GetListRecipesSortByEnumStringValues() []string
GetListRecipesSortByEnumStringValues Enumerates the set of values in String for ListRecipesSortByEnum
func GetListRecipesSortOrderEnumStringValues() []string
GetListRecipesSortOrderEnumStringValues Enumerates the set of values in String for ListRecipesSortOrderEnum
func GetListTrailFilesSortByEnumStringValues() []string
GetListTrailFilesSortByEnumStringValues Enumerates the set of values in String for ListTrailFilesSortByEnum
func GetListTrailFilesSortOrderEnumStringValues() []string
GetListTrailFilesSortOrderEnumStringValues Enumerates the set of values in String for ListTrailFilesSortOrderEnum
func GetListTrailSequencesSortByEnumStringValues() []string
GetListTrailSequencesSortByEnumStringValues Enumerates the set of values in String for ListTrailSequencesSortByEnum
func GetListTrailSequencesSortOrderEnumStringValues() []string
GetListTrailSequencesSortOrderEnumStringValues Enumerates the set of values in String for ListTrailSequencesSortOrderEnum
func GetMaintenanceActionTypeEnumStringValues() []string
GetMaintenanceActionTypeEnumStringValues Enumerates the set of values in String for MaintenanceActionTypeEnum
func GetMappingTypeEnumStringValues() []string
GetMappingTypeEnumStringValues Enumerates the set of values in String for MappingTypeEnum
func GetMessageSummaryDeploymentMessageStatusEnumStringValues() []string
GetMessageSummaryDeploymentMessageStatusEnumStringValues Enumerates the set of values in String for MessageSummaryDeploymentMessageStatusEnum
func GetMicrosoftFabricConnectionTechnologyTypeEnumStringValues() []string
GetMicrosoftFabricConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for MicrosoftFabricConnectionTechnologyTypeEnum
func GetMicrosoftSqlserverConnectionSecurityProtocolEnumStringValues() []string
GetMicrosoftSqlserverConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for MicrosoftSqlserverConnectionSecurityProtocolEnum
func GetMicrosoftSqlserverConnectionTechnologyTypeEnumStringValues() []string
GetMicrosoftSqlserverConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for MicrosoftSqlserverConnectionTechnologyTypeEnum
func GetMongoDbConnectionSecurityProtocolEnumStringValues() []string
GetMongoDbConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for MongoDbConnectionSecurityProtocolEnum
func GetMongoDbConnectionTechnologyTypeEnumStringValues() []string
GetMongoDbConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for MongoDbConnectionTechnologyTypeEnum
func GetMysqlConnectionSecurityProtocolEnumStringValues() []string
GetMysqlConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for MysqlConnectionSecurityProtocolEnum
func GetMysqlConnectionSslModeEnumStringValues() []string
GetMysqlConnectionSslModeEnumStringValues Enumerates the set of values in String for MysqlConnectionSslModeEnum
func GetMysqlConnectionTechnologyTypeEnumStringValues() []string
GetMysqlConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for MysqlConnectionTechnologyTypeEnum
func GetOciObjectStorageConnectionTechnologyTypeEnumStringValues() []string
GetOciObjectStorageConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for OciObjectStorageConnectionTechnologyTypeEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetOracleConnectionAuthenticationModeEnumStringValues() []string
GetOracleConnectionAuthenticationModeEnumStringValues Enumerates the set of values in String for OracleConnectionAuthenticationModeEnum
func GetOracleConnectionSessionModeEnumStringValues() []string
GetOracleConnectionSessionModeEnumStringValues Enumerates the set of values in String for OracleConnectionSessionModeEnum
func GetOracleConnectionTechnologyTypeEnumStringValues() []string
GetOracleConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for OracleConnectionTechnologyTypeEnum
func GetOracleNosqlConnectionTechnologyTypeEnumStringValues() []string
GetOracleNosqlConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for OracleNosqlConnectionTechnologyTypeEnum
func GetPipelineLifecycleStateEnumStringValues() []string
GetPipelineLifecycleStateEnumStringValues Enumerates the set of values in String for PipelineLifecycleStateEnum
func GetPipelineLifecycleSubStateEnumStringValues() []string
GetPipelineLifecycleSubStateEnumStringValues Enumerates the set of values in String for PipelineLifecycleSubStateEnum
func GetPostgresqlConnectionSecurityProtocolEnumStringValues() []string
GetPostgresqlConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for PostgresqlConnectionSecurityProtocolEnum
func GetPostgresqlConnectionSslModeEnumStringValues() []string
GetPostgresqlConnectionSslModeEnumStringValues Enumerates the set of values in String for PostgresqlConnectionSslModeEnum
func GetPostgresqlConnectionTechnologyTypeEnumStringValues() []string
GetPostgresqlConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for PostgresqlConnectionTechnologyTypeEnum
func GetProcessOptionsShouldRestartOnFailureEnumStringValues() []string
GetProcessOptionsShouldRestartOnFailureEnumStringValues Enumerates the set of values in String for ProcessOptionsShouldRestartOnFailureEnum
func GetProcessStatusTypeEnumStringValues() []string
GetProcessStatusTypeEnumStringValues Enumerates the set of values in String for ProcessStatusTypeEnum
func GetProcessTypeEnumStringValues() []string
GetProcessTypeEnumStringValues Enumerates the set of values in String for ProcessTypeEnum
func GetRecipeTypeEnumStringValues() []string
GetRecipeTypeEnumStringValues Enumerates the set of values in String for RecipeTypeEnum
func GetRedisConnectionAuthenticationTypeEnumStringValues() []string
GetRedisConnectionAuthenticationTypeEnumStringValues Enumerates the set of values in String for RedisConnectionAuthenticationTypeEnum
func GetRedisConnectionSecurityProtocolEnumStringValues() []string
GetRedisConnectionSecurityProtocolEnumStringValues Enumerates the set of values in String for RedisConnectionSecurityProtocolEnum
func GetRedisConnectionTechnologyTypeEnumStringValues() []string
GetRedisConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for RedisConnectionTechnologyTypeEnum
func GetRefreshConnectionTypeEnumStringValues() []string
GetRefreshConnectionTypeEnumStringValues Enumerates the set of values in String for RefreshConnectionTypeEnum
func GetReleaseTypeEnumStringValues() []string
GetReleaseTypeEnumStringValues Enumerates the set of values in String for ReleaseTypeEnum
func GetRemoveResourceLockDetailsTypeEnumStringValues() []string
GetRemoveResourceLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveResourceLockDetailsTypeEnum
func GetReplicateDdlErrorActionEnumStringValues() []string
GetReplicateDdlErrorActionEnumStringValues Enumerates the set of values in String for ReplicateDdlErrorActionEnum
func GetReplicateDmlErrorActionEnumStringValues() []string
GetReplicateDmlErrorActionEnumStringValues Enumerates the set of values in String for ReplicateDmlErrorActionEnum
func GetReplicateSchemaChangeCanReplicateSchemaChangeEnumStringValues() []string
GetReplicateSchemaChangeCanReplicateSchemaChangeEnumStringValues Enumerates the set of values in String for ReplicateSchemaChangeCanReplicateSchemaChangeEnum
func GetRescheduleDeploymentUpgradeTypeEnumStringValues() []string
GetRescheduleDeploymentUpgradeTypeEnumStringValues Enumerates the set of values in String for RescheduleDeploymentUpgradeTypeEnum
func GetResourceLockTypeEnumStringValues() []string
GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum
func GetRestoreDeploymentTypeEnumStringValues() []string
GetRestoreDeploymentTypeEnumStringValues Enumerates the set of values in String for RestoreDeploymentTypeEnum
func GetRollbackDeploymentUpgradeTypeEnumStringValues() []string
GetRollbackDeploymentUpgradeTypeEnumStringValues Enumerates the set of values in String for RollbackDeploymentUpgradeTypeEnum
func GetRoutingMethodEnumStringValues() []string
GetRoutingMethodEnumStringValues Enumerates the set of values in String for RoutingMethodEnum
func GetSeverityTypeEnumStringValues() []string
GetSeverityTypeEnumStringValues Enumerates the set of values in String for SeverityTypeEnum
func GetSnoozeDeploymentUpgradeTypeEnumStringValues() []string
GetSnoozeDeploymentUpgradeTypeEnumStringValues Enumerates the set of values in String for SnoozeDeploymentUpgradeTypeEnum
func GetSnowflakeConnectionAuthenticationTypeEnumStringValues() []string
GetSnowflakeConnectionAuthenticationTypeEnumStringValues Enumerates the set of values in String for SnowflakeConnectionAuthenticationTypeEnum
func GetSnowflakeConnectionTechnologyTypeEnumStringValues() []string
GetSnowflakeConnectionTechnologyTypeEnumStringValues Enumerates the set of values in String for SnowflakeConnectionTechnologyTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetStartDeploymentTypeEnumStringValues() []string
GetStartDeploymentTypeEnumStringValues Enumerates the set of values in String for StartDeploymentTypeEnum
func GetStartPipelineTypeEnumStringValues() []string
GetStartPipelineTypeEnumStringValues Enumerates the set of values in String for StartPipelineTypeEnum
func GetStepStatusTypeEnumStringValues() []string
GetStepStatusTypeEnumStringValues Enumerates the set of values in String for StepStatusTypeEnum
func GetStopDeploymentTypeEnumStringValues() []string
GetStopDeploymentTypeEnumStringValues Enumerates the set of values in String for StopDeploymentTypeEnum
func GetStopPipelineTypeEnumStringValues() []string
GetStopPipelineTypeEnumStringValues Enumerates the set of values in String for StopPipelineTypeEnum
func GetTechnologyTypeEnumStringValues() []string
GetTechnologyTypeEnumStringValues Enumerates the set of values in String for TechnologyTypeEnum
func GetTestConnectionAssignmentResultResultTypeEnumStringValues() []string
GetTestConnectionAssignmentResultResultTypeEnumStringValues Enumerates the set of values in String for TestConnectionAssignmentResultResultTypeEnum
func GetTestConnectionAssignmentTypeEnumStringValues() []string
GetTestConnectionAssignmentTypeEnumStringValues Enumerates the set of values in String for TestConnectionAssignmentTypeEnum
func GetTestPipelineConnectionResultResultTypeEnumStringValues() []string
GetTestPipelineConnectionResultResultTypeEnumStringValues Enumerates the set of values in String for TestPipelineConnectionResultResultTypeEnum
func GetTestPipelineConnectionTypeEnumStringValues() []string
GetTestPipelineConnectionTypeEnumStringValues Enumerates the set of values in String for TestPipelineConnectionTypeEnum
func GetUpdateBackupScheduleDetailsFrequencyBackupScheduledEnumStringValues() []string
GetUpdateBackupScheduleDetailsFrequencyBackupScheduledEnumStringValues Enumerates the set of values in String for UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum
func GetUpdateDatabaseRegistrationDetailsSessionModeEnumStringValues() []string
GetUpdateDatabaseRegistrationDetailsSessionModeEnumStringValues Enumerates the set of values in String for UpdateDatabaseRegistrationDetailsSessionModeEnum
func GetUpgradeDeploymentTypeEnumStringValues() []string
GetUpgradeDeploymentTypeEnumStringValues Enumerates the set of values in String for UpgradeDeploymentTypeEnum
func GetUpgradeDeploymentUpgradeTypeEnumStringValues() []string
GetUpgradeDeploymentUpgradeTypeEnumStringValues Enumerates the set of values in String for UpgradeDeploymentUpgradeTypeEnum
func GetWalletExistsDeploymentTypeEnumStringValues() []string
GetWalletExistsDeploymentTypeEnumStringValues Enumerates the set of values in String for WalletExistsDeploymentTypeEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddConnectionLockRequest wrapper for the AddConnectionLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/AddConnectionLock.go.html to see an example of how to use AddConnectionLockRequest.
type AddConnectionLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Connection.
ConnectionId *string `mandatory:"true" contributesTo:"path" name:"connectionId"`
// AddResourceLockDetails body parameter
AddResourceLockDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request AddConnectionLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddConnectionLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddConnectionLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddConnectionLockRequest) String() string
func (request AddConnectionLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddConnectionLockResponse wrapper for the AddConnectionLock operation
type AddConnectionLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Connection instance
Connection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// etag for the returned Connection resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response AddConnectionLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddConnectionLockResponse) String() string
AddDeploymentBackupLockRequest wrapper for the AddDeploymentBackupLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/AddDeploymentBackupLock.go.html to see an example of how to use AddDeploymentBackupLockRequest.
type AddDeploymentBackupLockRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// AddResourceLockDetails body parameter
AddResourceLockDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request AddDeploymentBackupLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddDeploymentBackupLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddDeploymentBackupLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddDeploymentBackupLockRequest) String() string
func (request AddDeploymentBackupLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddDeploymentBackupLockResponse wrapper for the AddDeploymentBackupLock operation
type AddDeploymentBackupLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentBackup instance
DeploymentBackup `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// etag for the returned DeploymentBackup resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response AddDeploymentBackupLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddDeploymentBackupLockResponse) String() string
AddDeploymentLockRequest wrapper for the AddDeploymentLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/AddDeploymentLock.go.html to see an example of how to use AddDeploymentLockRequest.
type AddDeploymentLockRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// AddResourceLockDetails body parameter
AddResourceLockDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request AddDeploymentLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddDeploymentLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddDeploymentLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddDeploymentLockRequest) String() string
func (request AddDeploymentLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddDeploymentLockResponse wrapper for the AddDeploymentLock operation
type AddDeploymentLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Deployment instance
Deployment `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// etag for the returned Deployment resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response AddDeploymentLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddDeploymentLockResponse) String() string
AddResourceLockDetails Used to add a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.
type AddResourceLockDetails struct {
// Type of the lock.
Type AddResourceLockDetailsTypeEnum `mandatory:"true" json:"type"`
// A message added by the creator of the lock. This is typically used to give an
// indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
}
func (m AddResourceLockDetails) String() string
func (m AddResourceLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddResourceLockDetailsTypeEnum Enum with underlying type: string
type AddResourceLockDetailsTypeEnum string
Set of constants representing the allowable values for AddResourceLockDetailsTypeEnum
const (
AddResourceLockDetailsTypeFull AddResourceLockDetailsTypeEnum = "FULL"
AddResourceLockDetailsTypeDelete AddResourceLockDetailsTypeEnum = "DELETE"
)
func GetAddResourceLockDetailsTypeEnumValues() []AddResourceLockDetailsTypeEnum
GetAddResourceLockDetailsTypeEnumValues Enumerates the set of values for AddResourceLockDetailsTypeEnum
func GetMappingAddResourceLockDetailsTypeEnum(val string) (AddResourceLockDetailsTypeEnum, bool)
GetMappingAddResourceLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AmazonKinesisConnection Represents the metadata of a Amazon Kinesis Connection.
type AmazonKinesisConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Access key ID to access the Amazon Kinesis.
AccessKeyId *string `mandatory:"true" json:"accessKeyId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the secret access key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// The Amazon Kinesis technology type.
TechnologyType AmazonKinesisConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m AmazonKinesisConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AmazonKinesisConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AmazonKinesisConnection) GetDescription() *string
GetDescription returns Description
func (m AmazonKinesisConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AmazonKinesisConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AmazonKinesisConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AmazonKinesisConnection) GetId() *string
GetId returns Id
func (m AmazonKinesisConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AmazonKinesisConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m AmazonKinesisConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AmazonKinesisConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AmazonKinesisConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AmazonKinesisConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AmazonKinesisConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AmazonKinesisConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AmazonKinesisConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AmazonKinesisConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AmazonKinesisConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AmazonKinesisConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m AmazonKinesisConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AmazonKinesisConnection) String() string
func (m AmazonKinesisConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AmazonKinesisConnectionSummary Summary of the Amazon Kinesis Connection.
type AmazonKinesisConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Access key ID to access the Amazon Kinesis.
AccessKeyId *string `mandatory:"true" json:"accessKeyId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the secret access key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Amazon Kinesis technology type.
TechnologyType AmazonKinesisConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m AmazonKinesisConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AmazonKinesisConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AmazonKinesisConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m AmazonKinesisConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AmazonKinesisConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AmazonKinesisConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AmazonKinesisConnectionSummary) GetId() *string
GetId returns Id
func (m AmazonKinesisConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AmazonKinesisConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m AmazonKinesisConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AmazonKinesisConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AmazonKinesisConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AmazonKinesisConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AmazonKinesisConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AmazonKinesisConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AmazonKinesisConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AmazonKinesisConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AmazonKinesisConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AmazonKinesisConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m AmazonKinesisConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AmazonKinesisConnectionSummary) String() string
func (m AmazonKinesisConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AmazonKinesisConnectionTechnologyTypeEnum Enum with underlying type: string
type AmazonKinesisConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for AmazonKinesisConnectionTechnologyTypeEnum
const (
AmazonKinesisConnectionTechnologyTypeAmazonKinesis AmazonKinesisConnectionTechnologyTypeEnum = "AMAZON_KINESIS"
)
func GetAmazonKinesisConnectionTechnologyTypeEnumValues() []AmazonKinesisConnectionTechnologyTypeEnum
GetAmazonKinesisConnectionTechnologyTypeEnumValues Enumerates the set of values for AmazonKinesisConnectionTechnologyTypeEnum
func GetMappingAmazonKinesisConnectionTechnologyTypeEnum(val string) (AmazonKinesisConnectionTechnologyTypeEnum, bool)
GetMappingAmazonKinesisConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AmazonRedshiftConnection Represents the metadata of a Amazon Redshift Connection.
type AmazonRedshiftConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Connection URL.
// e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The Amazon Redshift technology type.
TechnologyType AmazonRedshiftConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m AmazonRedshiftConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AmazonRedshiftConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AmazonRedshiftConnection) GetDescription() *string
GetDescription returns Description
func (m AmazonRedshiftConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AmazonRedshiftConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AmazonRedshiftConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AmazonRedshiftConnection) GetId() *string
GetId returns Id
func (m AmazonRedshiftConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AmazonRedshiftConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m AmazonRedshiftConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AmazonRedshiftConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AmazonRedshiftConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AmazonRedshiftConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AmazonRedshiftConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AmazonRedshiftConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AmazonRedshiftConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AmazonRedshiftConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AmazonRedshiftConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AmazonRedshiftConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m AmazonRedshiftConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AmazonRedshiftConnection) String() string
func (m AmazonRedshiftConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AmazonRedshiftConnectionSummary Summary of the Amazon Redshift Connection.
type AmazonRedshiftConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Connection URL.
// e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Amazon Redshift technology type.
TechnologyType AmazonRedshiftConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m AmazonRedshiftConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AmazonRedshiftConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AmazonRedshiftConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m AmazonRedshiftConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AmazonRedshiftConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AmazonRedshiftConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AmazonRedshiftConnectionSummary) GetId() *string
GetId returns Id
func (m AmazonRedshiftConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AmazonRedshiftConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m AmazonRedshiftConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AmazonRedshiftConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AmazonRedshiftConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AmazonRedshiftConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AmazonRedshiftConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AmazonRedshiftConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AmazonRedshiftConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AmazonRedshiftConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AmazonRedshiftConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AmazonRedshiftConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m AmazonRedshiftConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AmazonRedshiftConnectionSummary) String() string
func (m AmazonRedshiftConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AmazonRedshiftConnectionTechnologyTypeEnum Enum with underlying type: string
type AmazonRedshiftConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for AmazonRedshiftConnectionTechnologyTypeEnum
const (
AmazonRedshiftConnectionTechnologyTypeAmazonRedshift AmazonRedshiftConnectionTechnologyTypeEnum = "AMAZON_REDSHIFT"
)
func GetAmazonRedshiftConnectionTechnologyTypeEnumValues() []AmazonRedshiftConnectionTechnologyTypeEnum
GetAmazonRedshiftConnectionTechnologyTypeEnumValues Enumerates the set of values for AmazonRedshiftConnectionTechnologyTypeEnum
func GetMappingAmazonRedshiftConnectionTechnologyTypeEnum(val string) (AmazonRedshiftConnectionTechnologyTypeEnum, bool)
GetMappingAmazonRedshiftConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AmazonS3Connection Represents the metadata of a Amazon S3 Connection.
type AmazonS3Connection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Access key ID to access the Amazon S3 bucket.
// e.g.: "this-is-not-the-secret"
AccessKeyId *string `mandatory:"true" json:"accessKeyId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// The Amazon S3 technology type.
TechnologyType AmazonS3ConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m AmazonS3Connection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AmazonS3Connection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AmazonS3Connection) GetDescription() *string
GetDescription returns Description
func (m AmazonS3Connection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AmazonS3Connection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AmazonS3Connection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AmazonS3Connection) GetId() *string
GetId returns Id
func (m AmazonS3Connection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AmazonS3Connection) GetKeyId() *string
GetKeyId returns KeyId
func (m AmazonS3Connection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AmazonS3Connection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AmazonS3Connection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AmazonS3Connection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AmazonS3Connection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AmazonS3Connection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AmazonS3Connection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AmazonS3Connection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AmazonS3Connection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AmazonS3Connection) GetVaultId() *string
GetVaultId returns VaultId
func (m AmazonS3Connection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AmazonS3Connection) String() string
func (m AmazonS3Connection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AmazonS3ConnectionSummary Summary of the Amazon S3 Connection.
type AmazonS3ConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Access key ID to access the Amazon S3 bucket.
// e.g.: "this-is-not-the-secret"
AccessKeyId *string `mandatory:"true" json:"accessKeyId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Amazon S3 technology type.
TechnologyType AmazonS3ConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m AmazonS3ConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AmazonS3ConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AmazonS3ConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m AmazonS3ConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AmazonS3ConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AmazonS3ConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AmazonS3ConnectionSummary) GetId() *string
GetId returns Id
func (m AmazonS3ConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AmazonS3ConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m AmazonS3ConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AmazonS3ConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AmazonS3ConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AmazonS3ConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AmazonS3ConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AmazonS3ConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AmazonS3ConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AmazonS3ConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AmazonS3ConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AmazonS3ConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m AmazonS3ConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AmazonS3ConnectionSummary) String() string
func (m AmazonS3ConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AmazonS3ConnectionTechnologyTypeEnum Enum with underlying type: string
type AmazonS3ConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for AmazonS3ConnectionTechnologyTypeEnum
const (
AmazonS3ConnectionTechnologyTypeAmazonS3 AmazonS3ConnectionTechnologyTypeEnum = "AMAZON_S3"
)
func GetAmazonS3ConnectionTechnologyTypeEnumValues() []AmazonS3ConnectionTechnologyTypeEnum
GetAmazonS3ConnectionTechnologyTypeEnumValues Enumerates the set of values for AmazonS3ConnectionTechnologyTypeEnum
func GetMappingAmazonS3ConnectionTechnologyTypeEnum(val string) (AmazonS3ConnectionTechnologyTypeEnum, bool)
GetMappingAmazonS3ConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AzureDataLakeStorageConnection Represents the metadata of a Azure Data Lake Storage Connection.
type AzureDataLakeStorageConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Sets the Azure storage account name.
AccountName *string `mandatory:"true" json:"accountName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
AzureTenantId *string `mandatory:"false" json:"azureTenantId"`
// Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"false" json:"clientId"`
// Azure Storage service endpoint.
// e.g: https://test.blob.core.windows.net
Endpoint *string `mandatory:"false" json:"endpoint"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.
// Note: When provided, 'accountKey' field must not be provided.
AccountKeySecretId *string `mandatory:"false" json:"accountKeySecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored.
// Note: When provided, 'sasToken' field must not be provided.
SasTokenSecretId *string `mandatory:"false" json:"sasTokenSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// The Azure Data Lake Storage technology type.
TechnologyType AzureDataLakeStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Azure Data Lake Storage.
AuthenticationType AzureDataLakeStorageConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m AzureDataLakeStorageConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AzureDataLakeStorageConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AzureDataLakeStorageConnection) GetDescription() *string
GetDescription returns Description
func (m AzureDataLakeStorageConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AzureDataLakeStorageConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AzureDataLakeStorageConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AzureDataLakeStorageConnection) GetId() *string
GetId returns Id
func (m AzureDataLakeStorageConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AzureDataLakeStorageConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m AzureDataLakeStorageConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AzureDataLakeStorageConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AzureDataLakeStorageConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AzureDataLakeStorageConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AzureDataLakeStorageConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AzureDataLakeStorageConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AzureDataLakeStorageConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AzureDataLakeStorageConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AzureDataLakeStorageConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AzureDataLakeStorageConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m AzureDataLakeStorageConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AzureDataLakeStorageConnection) String() string
func (m AzureDataLakeStorageConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AzureDataLakeStorageConnectionAuthenticationTypeEnum Enum with underlying type: string
type AzureDataLakeStorageConnectionAuthenticationTypeEnum string
Set of constants representing the allowable values for AzureDataLakeStorageConnectionAuthenticationTypeEnum
const (
AzureDataLakeStorageConnectionAuthenticationTypeEnum = "SHARED_KEY"
AzureDataLakeStorageConnectionAuthenticationTypeEnum = "SHARED_ACCESS_SIGNATURE"
AzureDataLakeStorageConnectionAuthenticationTypeAzureActiveDirectory AzureDataLakeStorageConnectionAuthenticationTypeEnum = "AZURE_ACTIVE_DIRECTORY"
)
func GetAzureDataLakeStorageConnectionAuthenticationTypeEnumValues() []AzureDataLakeStorageConnectionAuthenticationTypeEnum
GetAzureDataLakeStorageConnectionAuthenticationTypeEnumValues Enumerates the set of values for AzureDataLakeStorageConnectionAuthenticationTypeEnum
func GetMappingAzureDataLakeStorageConnectionAuthenticationTypeEnum(val string) (AzureDataLakeStorageConnectionAuthenticationTypeEnum, bool)
GetMappingAzureDataLakeStorageConnectionAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AzureDataLakeStorageConnectionSummary Summary of the Azure Data Lake Storage Connection.
type AzureDataLakeStorageConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Sets the Azure storage account name.
AccountName *string `mandatory:"true" json:"accountName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
AzureTenantId *string `mandatory:"false" json:"azureTenantId"`
// Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"false" json:"clientId"`
// Azure Storage service endpoint.
// e.g: https://test.blob.core.windows.net
Endpoint *string `mandatory:"false" json:"endpoint"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.
// Note: When provided, 'accountKey' field must not be provided.
AccountKeySecretId *string `mandatory:"false" json:"accountKeySecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored.
// Note: When provided, 'sasToken' field must not be provided.
SasTokenSecretId *string `mandatory:"false" json:"sasTokenSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Azure Data Lake Storage technology type.
TechnologyType AzureDataLakeStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Azure Data Lake Storage.
AuthenticationType AzureDataLakeStorageConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m AzureDataLakeStorageConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AzureDataLakeStorageConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AzureDataLakeStorageConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m AzureDataLakeStorageConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AzureDataLakeStorageConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AzureDataLakeStorageConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AzureDataLakeStorageConnectionSummary) GetId() *string
GetId returns Id
func (m AzureDataLakeStorageConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AzureDataLakeStorageConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m AzureDataLakeStorageConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AzureDataLakeStorageConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AzureDataLakeStorageConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AzureDataLakeStorageConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AzureDataLakeStorageConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AzureDataLakeStorageConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AzureDataLakeStorageConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AzureDataLakeStorageConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AzureDataLakeStorageConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AzureDataLakeStorageConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m AzureDataLakeStorageConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AzureDataLakeStorageConnectionSummary) String() string
func (m AzureDataLakeStorageConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AzureDataLakeStorageConnectionTechnologyTypeEnum Enum with underlying type: string
type AzureDataLakeStorageConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for AzureDataLakeStorageConnectionTechnologyTypeEnum
const (
AzureDataLakeStorageConnectionTechnologyTypeAzureDataLakeStorage AzureDataLakeStorageConnectionTechnologyTypeEnum = "AZURE_DATA_LAKE_STORAGE"
)
func GetAzureDataLakeStorageConnectionTechnologyTypeEnumValues() []AzureDataLakeStorageConnectionTechnologyTypeEnum
GetAzureDataLakeStorageConnectionTechnologyTypeEnumValues Enumerates the set of values for AzureDataLakeStorageConnectionTechnologyTypeEnum
func GetMappingAzureDataLakeStorageConnectionTechnologyTypeEnum(val string) (AzureDataLakeStorageConnectionTechnologyTypeEnum, bool)
GetMappingAzureDataLakeStorageConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AzureSynapseConnection Represents the metadata of a Azure Synapse Analytics Connection.
type AzureSynapseConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// JDBC connection string.
// e.g.: 'jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db-name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
ConnectionString *string `mandatory:"true" json:"connectionString"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The Azure Synapse Analytics technology type.
TechnologyType AzureSynapseConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m AzureSynapseConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AzureSynapseConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AzureSynapseConnection) GetDescription() *string
GetDescription returns Description
func (m AzureSynapseConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AzureSynapseConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AzureSynapseConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AzureSynapseConnection) GetId() *string
GetId returns Id
func (m AzureSynapseConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AzureSynapseConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m AzureSynapseConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AzureSynapseConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AzureSynapseConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AzureSynapseConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AzureSynapseConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AzureSynapseConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AzureSynapseConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AzureSynapseConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AzureSynapseConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AzureSynapseConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m AzureSynapseConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AzureSynapseConnection) String() string
func (m AzureSynapseConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AzureSynapseConnectionSummary Summary of the Azure Synapse Analytics Connection.
type AzureSynapseConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// JDBC connection string.
// e.g.: 'jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db-name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
ConnectionString *string `mandatory:"true" json:"connectionString"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Azure Synapse Analytics technology type.
TechnologyType AzureSynapseConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m AzureSynapseConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AzureSynapseConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AzureSynapseConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m AzureSynapseConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m AzureSynapseConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m AzureSynapseConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AzureSynapseConnectionSummary) GetId() *string
GetId returns Id
func (m AzureSynapseConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m AzureSynapseConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m AzureSynapseConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m AzureSynapseConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AzureSynapseConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m AzureSynapseConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m AzureSynapseConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m AzureSynapseConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m AzureSynapseConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m AzureSynapseConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AzureSynapseConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AzureSynapseConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m AzureSynapseConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AzureSynapseConnectionSummary) String() string
func (m AzureSynapseConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AzureSynapseConnectionTechnologyTypeEnum Enum with underlying type: string
type AzureSynapseConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for AzureSynapseConnectionTechnologyTypeEnum
const (
AzureSynapseConnectionTechnologyTypeAzureSynapseAnalytics AzureSynapseConnectionTechnologyTypeEnum = "AZURE_SYNAPSE_ANALYTICS"
)
func GetAzureSynapseConnectionTechnologyTypeEnumValues() []AzureSynapseConnectionTechnologyTypeEnum
GetAzureSynapseConnectionTechnologyTypeEnumValues Enumerates the set of values for AzureSynapseConnectionTechnologyTypeEnum
func GetMappingAzureSynapseConnectionTechnologyTypeEnum(val string) (AzureSynapseConnectionTechnologyTypeEnum, bool)
GetMappingAzureSynapseConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BackupSchedule Defines the schedule of the deployment backup.
type BackupSchedule struct {
// The start timestamp for the deployment backup schedule. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.
TimeBackupScheduled *common.SDKTime `mandatory:"true" json:"timeBackupScheduled"`
// The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
FrequencyBackupScheduled BackupScheduleFrequencyBackupScheduledEnum `mandatory:"true" json:"frequencyBackupScheduled"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"true" json:"bucketName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Parameter to allow users to create backup without trails
IsMetadataOnly *bool `mandatory:"true" json:"isMetadataOnly"`
}
func (m BackupSchedule) String() string
func (m BackupSchedule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupScheduleFrequencyBackupScheduledEnum Enum with underlying type: string
type BackupScheduleFrequencyBackupScheduledEnum string
Set of constants representing the allowable values for BackupScheduleFrequencyBackupScheduledEnum
const (
BackupScheduleFrequencyBackupScheduledDaily BackupScheduleFrequencyBackupScheduledEnum = "DAILY"
BackupScheduleFrequencyBackupScheduledWeekly BackupScheduleFrequencyBackupScheduledEnum = "WEEKLY"
BackupScheduleFrequencyBackupScheduledMonthly BackupScheduleFrequencyBackupScheduledEnum = "MONTHLY"
)
func GetBackupScheduleFrequencyBackupScheduledEnumValues() []BackupScheduleFrequencyBackupScheduledEnum
GetBackupScheduleFrequencyBackupScheduledEnumValues Enumerates the set of values for BackupScheduleFrequencyBackupScheduledEnum
func GetMappingBackupScheduleFrequencyBackupScheduledEnum(val string) (BackupScheduleFrequencyBackupScheduledEnum, bool)
GetMappingBackupScheduleFrequencyBackupScheduledEnum performs case Insensitive comparison on enum value and return the desired enum
CancelDeploymentBackupDetails The information about the Cancel for a DeploymentBackup.
type CancelDeploymentBackupDetails interface {
}
CancelDeploymentBackupRequest wrapper for the CancelDeploymentBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CancelDeploymentBackup.go.html to see an example of how to use CancelDeploymentBackupRequest.
type CancelDeploymentBackupRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// A placeholder for any additional metadata to describe the deployment backup cancel.
CancelDeploymentBackupDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelDeploymentBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelDeploymentBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelDeploymentBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelDeploymentBackupRequest) String() string
func (request CancelDeploymentBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelDeploymentBackupResponse wrapper for the CancelDeploymentBackup operation
type CancelDeploymentBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelDeploymentBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelDeploymentBackupResponse) String() string
CancelDeploymentBackupTypeEnum Enum with underlying type: string
type CancelDeploymentBackupTypeEnum string
Set of constants representing the allowable values for CancelDeploymentBackupTypeEnum
const (
CancelDeploymentBackupTypeDefault CancelDeploymentBackupTypeEnum = "DEFAULT"
)
func GetCancelDeploymentBackupTypeEnumValues() []CancelDeploymentBackupTypeEnum
GetCancelDeploymentBackupTypeEnumValues Enumerates the set of values for CancelDeploymentBackupTypeEnum
func GetMappingCancelDeploymentBackupTypeEnum(val string) (CancelDeploymentBackupTypeEnum, bool)
GetMappingCancelDeploymentBackupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelDeploymentUpgradeDetails The information about canceling.
type CancelDeploymentUpgradeDetails interface {
}
CancelDeploymentUpgradeRequest wrapper for the CancelDeploymentUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CancelDeploymentUpgrade.go.html to see an example of how to use CancelDeploymentUpgradeRequest.
type CancelDeploymentUpgradeRequest struct {
// A unique Deployment Upgrade identifier.
DeploymentUpgradeId *string `mandatory:"true" contributesTo:"path" name:"deploymentUpgradeId"`
// A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.
CancelDeploymentUpgradeDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelDeploymentUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelDeploymentUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelDeploymentUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelDeploymentUpgradeRequest) String() string
func (request CancelDeploymentUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelDeploymentUpgradeResponse wrapper for the CancelDeploymentUpgrade operation
type CancelDeploymentUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentUpgrade instance
DeploymentUpgrade `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelDeploymentUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelDeploymentUpgradeResponse) String() string
CancelDeploymentUpgradeTypeEnum Enum with underlying type: string
type CancelDeploymentUpgradeTypeEnum string
Set of constants representing the allowable values for CancelDeploymentUpgradeTypeEnum
const (
CancelDeploymentUpgradeTypeDefault CancelDeploymentUpgradeTypeEnum = "DEFAULT"
)
func GetCancelDeploymentUpgradeTypeEnumValues() []CancelDeploymentUpgradeTypeEnum
GetCancelDeploymentUpgradeTypeEnumValues Enumerates the set of values for CancelDeploymentUpgradeTypeEnum
func GetMappingCancelDeploymentUpgradeTypeEnum(val string) (CancelDeploymentUpgradeTypeEnum, bool)
GetMappingCancelDeploymentUpgradeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelSnoozeDeploymentUpgradeDetails The information about snooze canceling.
type CancelSnoozeDeploymentUpgradeDetails interface {
}
CancelSnoozeDeploymentUpgradeRequest wrapper for the CancelSnoozeDeploymentUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CancelSnoozeDeploymentUpgrade.go.html to see an example of how to use CancelSnoozeDeploymentUpgradeRequest.
type CancelSnoozeDeploymentUpgradeRequest struct {
// A unique Deployment Upgrade identifier.
DeploymentUpgradeId *string `mandatory:"true" contributesTo:"path" name:"deploymentUpgradeId"`
// A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.
CancelSnoozeDeploymentUpgradeDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelSnoozeDeploymentUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelSnoozeDeploymentUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelSnoozeDeploymentUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelSnoozeDeploymentUpgradeRequest) String() string
func (request CancelSnoozeDeploymentUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelSnoozeDeploymentUpgradeResponse wrapper for the CancelSnoozeDeploymentUpgrade operation
type CancelSnoozeDeploymentUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelSnoozeDeploymentUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelSnoozeDeploymentUpgradeResponse) String() string
CancelSnoozeDeploymentUpgradeTypeEnum Enum with underlying type: string
type CancelSnoozeDeploymentUpgradeTypeEnum string
Set of constants representing the allowable values for CancelSnoozeDeploymentUpgradeTypeEnum
const (
CancelSnoozeDeploymentUpgradeTypeDefault CancelSnoozeDeploymentUpgradeTypeEnum = "DEFAULT"
)
func GetCancelSnoozeDeploymentUpgradeTypeEnumValues() []CancelSnoozeDeploymentUpgradeTypeEnum
GetCancelSnoozeDeploymentUpgradeTypeEnumValues Enumerates the set of values for CancelSnoozeDeploymentUpgradeTypeEnum
func GetMappingCancelSnoozeDeploymentUpgradeTypeEnum(val string) (CancelSnoozeDeploymentUpgradeTypeEnum, bool)
GetMappingCancelSnoozeDeploymentUpgradeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Certificate Certificate data.
type Certificate struct {
// The identifier key (unique name in the scope of the deployment) of the certificate being referenced.
// It must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
Key *string `mandatory:"true" json:"key"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// The base64 encoded content of the PEM file containing the SSL certificate.
CertificateContent *string `mandatory:"true" json:"certificateContent"`
// The Certificate issuer.
Issuer *string `mandatory:"true" json:"issuer"`
// Indicates if the certificate is self signed.
IsSelfSigned *bool `mandatory:"true" json:"isSelfSigned"`
// The Certificate md5Hash.
Md5Hash *string `mandatory:"true" json:"md5Hash"`
// The Certificate public key.
PublicKey *string `mandatory:"true" json:"publicKey"`
// The Certificate public key algorithm.
PublicKeyAlgorithm *string `mandatory:"true" json:"publicKeyAlgorithm"`
// The Certificate public key size.
PublicKeySize *int64 `mandatory:"true" json:"publicKeySize"`
// The Certificate serial.
Serial *string `mandatory:"true" json:"serial"`
// The Certificate subject.
Subject *string `mandatory:"true" json:"subject"`
// The time the certificate is valid from. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeValidFrom *common.SDKTime `mandatory:"true" json:"timeValidFrom"`
// The time the certificate is valid to. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeValidTo *common.SDKTime `mandatory:"true" json:"timeValidTo"`
// The Certificate version.
Version *string `mandatory:"true" json:"version"`
// The Certificate sha1 hash.
Sha1Hash *string `mandatory:"true" json:"sha1Hash"`
// The Certificate authority key id.
AuthorityKeyId *string `mandatory:"true" json:"authorityKeyId"`
// Indicates if the certificate is ca.
IsCa *bool `mandatory:"true" json:"isCa"`
// The Certificate subject key id.
SubjectKeyId *string `mandatory:"true" json:"subjectKeyId"`
// Possible certificate lifecycle states.
LifecycleState CertificateLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}
func (m Certificate) String() string
func (m Certificate) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CertificateCollection A list of Certificates.
type CertificateCollection struct {
// An array of Certificates.
Items []CertificateSummary `mandatory:"true" json:"items"`
}
func (m CertificateCollection) String() string
func (m CertificateCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CertificateLifecycleStateEnum Enum with underlying type: string
type CertificateLifecycleStateEnum string
Set of constants representing the allowable values for CertificateLifecycleStateEnum
const (
CertificateLifecycleStateCreating CertificateLifecycleStateEnum = "CREATING"
CertificateLifecycleStateActive CertificateLifecycleStateEnum = "ACTIVE"
CertificateLifecycleStateDeleting CertificateLifecycleStateEnum = "DELETING"
CertificateLifecycleStateDeleted CertificateLifecycleStateEnum = "DELETED"
CertificateLifecycleStateFailed CertificateLifecycleStateEnum = "FAILED"
)
func GetCertificateLifecycleStateEnumValues() []CertificateLifecycleStateEnum
GetCertificateLifecycleStateEnumValues Enumerates the set of values for CertificateLifecycleStateEnum
func GetMappingCertificateLifecycleStateEnum(val string) (CertificateLifecycleStateEnum, bool)
GetMappingCertificateLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
CertificateSummary Summary of the Certificates.
type CertificateSummary struct {
// The identifier key (unique name in the scope of the deployment) of the certificate being referenced.
// It must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
Key *string `mandatory:"true" json:"key"`
// Possible certificate lifecycle states.
LifecycleState CertificateLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The Certificate subject.
Subject *string `mandatory:"true" json:"subject"`
// Indicates if the certificate is self signed.
IsSelfSigned *bool `mandatory:"true" json:"isSelfSigned"`
// The time the certificate is valid to. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeValidTo *common.SDKTime `mandatory:"true" json:"timeValidTo"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}
func (m CertificateSummary) String() string
func (m CertificateSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeConnectionCompartmentDetails The new compartment for a Connection.
type ChangeConnectionCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeConnectionCompartmentDetails) String() string
func (m ChangeConnectionCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeConnectionCompartmentRequest wrapper for the ChangeConnectionCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeConnectionCompartment.go.html to see an example of how to use ChangeConnectionCompartmentRequest.
type ChangeConnectionCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Connection.
ConnectionId *string `mandatory:"true" contributesTo:"path" name:"connectionId"`
// Properties to change the compartment of a Connection.
ChangeConnectionCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeConnectionCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeConnectionCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeConnectionCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeConnectionCompartmentRequest) String() string
func (request ChangeConnectionCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeConnectionCompartmentResponse wrapper for the ChangeConnectionCompartment operation
type ChangeConnectionCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeConnectionCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeConnectionCompartmentResponse) String() string
ChangeDatabaseRegistrationCompartmentDetails The new compartment for a DatabaseRegistration.
type ChangeDatabaseRegistrationCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDatabaseRegistrationCompartmentDetails) String() string
func (m ChangeDatabaseRegistrationCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDatabaseRegistrationCompartmentRequest wrapper for the ChangeDatabaseRegistrationCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeDatabaseRegistrationCompartment.go.html to see an example of how to use ChangeDatabaseRegistrationCompartmentRequest.
type ChangeDatabaseRegistrationCompartmentRequest struct {
// A unique DatabaseRegistration identifier.
DatabaseRegistrationId *string `mandatory:"true" contributesTo:"path" name:"databaseRegistrationId"`
// Properties to change the compartment of a DatabaseRegistration.
ChangeDatabaseRegistrationCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeDatabaseRegistrationCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDatabaseRegistrationCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDatabaseRegistrationCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDatabaseRegistrationCompartmentRequest) String() string
func (request ChangeDatabaseRegistrationCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDatabaseRegistrationCompartmentResponse wrapper for the ChangeDatabaseRegistrationCompartment operation
type ChangeDatabaseRegistrationCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Deprecation date of this API version.
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response ChangeDatabaseRegistrationCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDatabaseRegistrationCompartmentResponse) String() string
ChangeDeploymentBackupCompartmentDetails The new compartment for a DeploymentBackup.
type ChangeDeploymentBackupCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDeploymentBackupCompartmentDetails) String() string
func (m ChangeDeploymentBackupCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDeploymentBackupCompartmentRequest wrapper for the ChangeDeploymentBackupCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeDeploymentBackupCompartment.go.html to see an example of how to use ChangeDeploymentBackupCompartmentRequest.
type ChangeDeploymentBackupCompartmentRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// Properties to change the compartment of a DeploymentBackup.
ChangeDeploymentBackupCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeDeploymentBackupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDeploymentBackupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDeploymentBackupCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDeploymentBackupCompartmentRequest) String() string
func (request ChangeDeploymentBackupCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDeploymentBackupCompartmentResponse wrapper for the ChangeDeploymentBackupCompartment operation
type ChangeDeploymentBackupCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeDeploymentBackupCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDeploymentBackupCompartmentResponse) String() string
ChangeDeploymentCompartmentDetails The new compartment for a Deployment.
type ChangeDeploymentCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDeploymentCompartmentDetails) String() string
func (m ChangeDeploymentCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDeploymentCompartmentRequest wrapper for the ChangeDeploymentCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeDeploymentCompartment.go.html to see an example of how to use ChangeDeploymentCompartmentRequest.
type ChangeDeploymentCompartmentRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// Properties to change the compartment of a Deployment.
ChangeDeploymentCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeDeploymentCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDeploymentCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDeploymentCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDeploymentCompartmentRequest) String() string
func (request ChangeDeploymentCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDeploymentCompartmentResponse wrapper for the ChangeDeploymentCompartment operation
type ChangeDeploymentCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeDeploymentCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDeploymentCompartmentResponse) String() string
ChangePipelineCompartmentDetails The new compartment for a Pipeline.
type ChangePipelineCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePipelineCompartmentDetails) String() string
func (m ChangePipelineCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangePipelineCompartmentRequest wrapper for the ChangePipelineCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangePipelineCompartment.go.html to see an example of how to use ChangePipelineCompartmentRequest.
type ChangePipelineCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// Properties to change the compartment of a Pipeline.
ChangePipelineCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangePipelineCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangePipelineCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangePipelineCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangePipelineCompartmentRequest) String() string
func (request ChangePipelineCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangePipelineCompartmentResponse wrapper for the ChangePipelineCompartment operation
type ChangePipelineCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangePipelineCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangePipelineCompartmentResponse) String() string
CollectDeploymentDiagnosticDetails Details for collecting deployment diagnostic
type CollectDeploymentDiagnosticDetails struct {
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"true" json:"bucketName"`
// Prefix of the diagnostic collected and uploaded to object storage
DiagnosticNamePrefix *string `mandatory:"true" json:"diagnosticNamePrefix"`
// The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeDiagnosticStart *common.SDKTime `mandatory:"false" json:"timeDiagnosticStart"`
// The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeDiagnosticEnd *common.SDKTime `mandatory:"false" json:"timeDiagnosticEnd"`
}
func (m CollectDeploymentDiagnosticDetails) String() string
func (m CollectDeploymentDiagnosticDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CollectDeploymentDiagnosticRequest wrapper for the CollectDeploymentDiagnostic operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CollectDeploymentDiagnostic.go.html to see an example of how to use CollectDeploymentDiagnosticRequest.
type CollectDeploymentDiagnosticRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// Metadata about the deployment diagnostic. This also includes the Object storage information where the diagnostic will be uploaded
CollectDeploymentDiagnosticDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CollectDeploymentDiagnosticRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CollectDeploymentDiagnosticRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CollectDeploymentDiagnosticRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CollectDeploymentDiagnosticRequest) String() string
func (request CollectDeploymentDiagnosticRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CollectDeploymentDiagnosticResponse wrapper for the CollectDeploymentDiagnostic operation
type CollectDeploymentDiagnosticResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CollectDeploymentDiagnosticResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CollectDeploymentDiagnosticResponse) String() string
Connection Represents the metadata description of a connection used by deployments in the same compartment.
type Connection interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
GetId() *string
// An object's Display Name.
GetDisplayName() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
GetCompartmentId() *string
// Possible lifecycle states for connection.
GetLifecycleState() ConnectionLifecycleStateEnum
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeCreated() *common.SDKTime
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeUpdated() *common.SDKTime
// Metadata about this specific object.
GetDescription() *string
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
GetSystemTags() map[string]map[string]interface{}
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
GetLifecycleDetails() *string
// Locks associated with this resource.
GetLocks() []ResourceLock
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
GetVaultId() *string
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
GetKeyId() *string
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
GetIngressIps() []IngressIpDetails
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
GetNsgIds() []string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
GetSubnetId() *string
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
GetRoutingMethod() RoutingMethodEnum
// Indicates that sensitive attributes are provided via Secrets.
GetDoesUseSecretIds() *bool
}
ConnectionAssignment Represents the metadata description of a connection assignment. Before you can use a connection as a GoldenGate source or target, you must assign it to a deployment.
type ConnectionAssignment struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection assignment being
// referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
ConnectionId *string `mandatory:"true" json:"connectionId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Possible lifecycle states for connection assignments.
LifecycleState ConnectionAssignmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Credential store alias.
AliasName *string `mandatory:"false" json:"aliasName"`
}
func (m ConnectionAssignment) String() string
func (m ConnectionAssignment) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectionAssignmentCollection List of connection summary objects.
type ConnectionAssignmentCollection struct {
// An array of Connection Assignment summaries.
Items []ConnectionAssignmentSummary `mandatory:"true" json:"items"`
}
func (m ConnectionAssignmentCollection) String() string
func (m ConnectionAssignmentCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectionAssignmentLifecycleStateEnum Enum with underlying type: string
type ConnectionAssignmentLifecycleStateEnum string
Set of constants representing the allowable values for ConnectionAssignmentLifecycleStateEnum
const (
ConnectionAssignmentLifecycleStateCreating ConnectionAssignmentLifecycleStateEnum = "CREATING"
ConnectionAssignmentLifecycleStateActive ConnectionAssignmentLifecycleStateEnum = "ACTIVE"
ConnectionAssignmentLifecycleStateFailed ConnectionAssignmentLifecycleStateEnum = "FAILED"
ConnectionAssignmentLifecycleStateUpdating ConnectionAssignmentLifecycleStateEnum = "UPDATING"
ConnectionAssignmentLifecycleStateDeleting ConnectionAssignmentLifecycleStateEnum = "DELETING"
)
func GetConnectionAssignmentLifecycleStateEnumValues() []ConnectionAssignmentLifecycleStateEnum
GetConnectionAssignmentLifecycleStateEnumValues Enumerates the set of values for ConnectionAssignmentLifecycleStateEnum
func GetMappingConnectionAssignmentLifecycleStateEnum(val string) (ConnectionAssignmentLifecycleStateEnum, bool)
GetMappingConnectionAssignmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConnectionAssignmentSummary Summary of the Connection Assignment.
type ConnectionAssignmentSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection assignment being
// referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
ConnectionId *string `mandatory:"true" json:"connectionId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// Credential store alias.
AliasName *string `mandatory:"true" json:"aliasName"`
// Possible lifecycle states for connection assignments.
LifecycleState ConnectionAssignmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m ConnectionAssignmentSummary) String() string
func (m ConnectionAssignmentSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectionCollection List of connection summary objects.
type ConnectionCollection struct {
// An array of Connection summaries.
Items []ConnectionSummary `mandatory:"true" json:"items"`
}
func (m ConnectionCollection) String() string
func (m *ConnectionCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ConnectionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectionLifecycleStateEnum Enum with underlying type: string
type ConnectionLifecycleStateEnum string
Set of constants representing the allowable values for ConnectionLifecycleStateEnum
const (
ConnectionLifecycleStateCreating ConnectionLifecycleStateEnum = "CREATING"
ConnectionLifecycleStateUpdating ConnectionLifecycleStateEnum = "UPDATING"
ConnectionLifecycleStateActive ConnectionLifecycleStateEnum = "ACTIVE"
ConnectionLifecycleStateDeleting ConnectionLifecycleStateEnum = "DELETING"
ConnectionLifecycleStateDeleted ConnectionLifecycleStateEnum = "DELETED"
ConnectionLifecycleStateFailed ConnectionLifecycleStateEnum = "FAILED"
)
func GetConnectionLifecycleStateEnumValues() []ConnectionLifecycleStateEnum
GetConnectionLifecycleStateEnumValues Enumerates the set of values for ConnectionLifecycleStateEnum
func GetMappingConnectionLifecycleStateEnum(val string) (ConnectionLifecycleStateEnum, bool)
GetMappingConnectionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConnectionSummary Summary of the Connection.
type ConnectionSummary interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
GetId() *string
// An object's Display Name.
GetDisplayName() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
GetCompartmentId() *string
// Possible lifecycle states for connection.
GetLifecycleState() ConnectionLifecycleStateEnum
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeCreated() *common.SDKTime
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeUpdated() *common.SDKTime
// Metadata about this specific object.
GetDescription() *string
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
GetSystemTags() map[string]map[string]interface{}
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
GetLifecycleDetails() *string
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
GetVaultId() *string
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
GetKeyId() *string
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
GetIngressIps() []IngressIpDetails
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
GetNsgIds() []string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
GetSubnetId() *string
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
GetRoutingMethod() RoutingMethodEnum
// Locks associated with this resource.
GetLocks() []ResourceLock
// Indicates that sensitive attributes are provided via Secrets.
GetDoesUseSecretIds() *bool
}
ConnectionTypeEnum Enum with underlying type: string
type ConnectionTypeEnum string
Set of constants representing the allowable values for ConnectionTypeEnum
const (
ConnectionTypeGoldengate ConnectionTypeEnum = "GOLDENGATE"
ConnectionTypeKafka ConnectionTypeEnum = "KAFKA"
ConnectionTypeKafkaSchemaRegistry ConnectionTypeEnum = "KAFKA_SCHEMA_REGISTRY"
ConnectionTypeMysql ConnectionTypeEnum = "MYSQL"
ConnectionTypeJavaMessageService ConnectionTypeEnum = "JAVA_MESSAGE_SERVICE"
ConnectionTypeMicrosoftSqlserver ConnectionTypeEnum = "MICROSOFT_SQLSERVER"
ConnectionTypeOciObjectStorage ConnectionTypeEnum = "OCI_OBJECT_STORAGE"
ConnectionTypeOracle ConnectionTypeEnum = "ORACLE"
ConnectionTypeAzureDataLakeStorage ConnectionTypeEnum = "AZURE_DATA_LAKE_STORAGE"
ConnectionTypePostgresql ConnectionTypeEnum = "POSTGRESQL"
ConnectionTypeAzureSynapseAnalytics ConnectionTypeEnum = "AZURE_SYNAPSE_ANALYTICS"
ConnectionTypeSnowflake ConnectionTypeEnum = "SNOWFLAKE"
ConnectionTypeAmazonS3 ConnectionTypeEnum = "AMAZON_S3"
ConnectionTypeHdfs ConnectionTypeEnum = "HDFS"
ConnectionTypeOracleNosql ConnectionTypeEnum = "ORACLE_NOSQL"
ConnectionTypeMongodb ConnectionTypeEnum = "MONGODB"
ConnectionTypeAmazonKinesis ConnectionTypeEnum = "AMAZON_KINESIS"
ConnectionTypeAmazonRedshift ConnectionTypeEnum = "AMAZON_REDSHIFT"
ConnectionTypeDb2 ConnectionTypeEnum = "DB2"
ConnectionTypeRedis ConnectionTypeEnum = "REDIS"
ConnectionTypeElasticsearch ConnectionTypeEnum = "ELASTICSEARCH"
ConnectionTypeGeneric ConnectionTypeEnum = "GENERIC"
ConnectionTypeGoogleCloudStorage ConnectionTypeEnum = "GOOGLE_CLOUD_STORAGE"
ConnectionTypeGoogleBigquery ConnectionTypeEnum = "GOOGLE_BIGQUERY"
ConnectionTypeDatabricks ConnectionTypeEnum = "DATABRICKS"
ConnectionTypeGooglePubsub ConnectionTypeEnum = "GOOGLE_PUBSUB"
ConnectionTypeMicrosoftFabric ConnectionTypeEnum = "MICROSOFT_FABRIC"
)
func GetConnectionTypeEnumValues() []ConnectionTypeEnum
GetConnectionTypeEnumValues Enumerates the set of values for ConnectionTypeEnum
func GetMappingConnectionTypeEnum(val string) (ConnectionTypeEnum, bool)
GetMappingConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CopyDeploymentBackupDetails The information about the copy for a Deployment Backup.
type CopyDeploymentBackupDetails struct {
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"true" json:"bucketName"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CopyDeploymentBackupDetails) String() string
func (m CopyDeploymentBackupDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CopyDeploymentBackupRequest wrapper for the CopyDeploymentBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CopyDeploymentBackup.go.html to see an example of how to use CopyDeploymentBackupRequest.
type CopyDeploymentBackupRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// A placeholder for any additional metadata to describe the copy of a Deployment Backup.
CopyDeploymentBackupDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CopyDeploymentBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CopyDeploymentBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CopyDeploymentBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CopyDeploymentBackupRequest) String() string
func (request CopyDeploymentBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CopyDeploymentBackupResponse wrapper for the CopyDeploymentBackup operation
type CopyDeploymentBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentBackup instance
DeploymentBackup `presentIn:"body"`
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CopyDeploymentBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CopyDeploymentBackupResponse) String() string
CreateAmazonKinesisConnectionDetails The information about a new Amazon Kinesis Connection.
type CreateAmazonKinesisConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Access key ID to access the Amazon Kinesis.
AccessKeyId *string `mandatory:"true" json:"accessKeyId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Secret access key to access the Amazon Kinesis.
// Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
SecretAccessKey *string `mandatory:"false" json:"secretAccessKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the secret access key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Amazon Kinesis technology type.
TechnologyType AmazonKinesisConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateAmazonKinesisConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateAmazonKinesisConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAmazonKinesisConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateAmazonKinesisConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateAmazonKinesisConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateAmazonKinesisConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAmazonKinesisConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateAmazonKinesisConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateAmazonKinesisConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateAmazonKinesisConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateAmazonKinesisConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateAmazonKinesisConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateAmazonKinesisConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAmazonKinesisConnectionDetails) String() string
func (m CreateAmazonKinesisConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAmazonRedshiftConnectionDetails The information about a new Amazon Redshift Connection.
type CreateAmazonRedshiftConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Connection URL.
// e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Amazon Redshift technology type.
TechnologyType AmazonRedshiftConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateAmazonRedshiftConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateAmazonRedshiftConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAmazonRedshiftConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateAmazonRedshiftConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateAmazonRedshiftConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateAmazonRedshiftConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAmazonRedshiftConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateAmazonRedshiftConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateAmazonRedshiftConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateAmazonRedshiftConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateAmazonRedshiftConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateAmazonRedshiftConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateAmazonRedshiftConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAmazonRedshiftConnectionDetails) String() string
func (m CreateAmazonRedshiftConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAmazonS3ConnectionDetails The information about a new Amazon S3 Connection.
type CreateAmazonS3ConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Access key ID to access the Amazon S3 bucket.
// e.g.: "this-is-not-the-secret"
AccessKeyId *string `mandatory:"true" json:"accessKeyId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Secret access key to access the Amazon S3 bucket.
// e.g.: "this-is-not-the-secret"
// Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
SecretAccessKey *string `mandatory:"false" json:"secretAccessKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Amazon S3 technology type.
TechnologyType AmazonS3ConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateAmazonS3ConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateAmazonS3ConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAmazonS3ConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateAmazonS3ConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateAmazonS3ConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateAmazonS3ConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAmazonS3ConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateAmazonS3ConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateAmazonS3ConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateAmazonS3ConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateAmazonS3ConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateAmazonS3ConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateAmazonS3ConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAmazonS3ConnectionDetails) String() string
func (m CreateAmazonS3ConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAzureDataLakeStorageConnectionDetails The information about a new Azure Data Lake Storage Connection.
type CreateAzureDataLakeStorageConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Sets the Azure storage account name.
AccountName *string `mandatory:"true" json:"accountName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'.
// e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==
// Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
AccountKey *string `mandatory:"false" json:"accountKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.
// Note: When provided, 'accountKey' field must not be provided.
AccountKeySecretId *string `mandatory:"false" json:"accountKeySecretId"`
// Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is
// required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'.
// e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D
// Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
SasToken *string `mandatory:"false" json:"sasToken"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored.
// Note: When provided, 'sasToken' field must not be provided.
SasTokenSecretId *string `mandatory:"false" json:"sasTokenSecretId"`
// Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
AzureTenantId *string `mandatory:"false" json:"azureTenantId"`
// Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"false" json:"clientId"`
// Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1
// Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Azure Storage service endpoint.
// e.g: https://test.blob.core.windows.net
Endpoint *string `mandatory:"false" json:"endpoint"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Azure Data Lake Storage technology type.
TechnologyType AzureDataLakeStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Azure Data Lake Storage.
AuthenticationType AzureDataLakeStorageConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m CreateAzureDataLakeStorageConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateAzureDataLakeStorageConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAzureDataLakeStorageConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateAzureDataLakeStorageConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateAzureDataLakeStorageConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateAzureDataLakeStorageConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAzureDataLakeStorageConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateAzureDataLakeStorageConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateAzureDataLakeStorageConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateAzureDataLakeStorageConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateAzureDataLakeStorageConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateAzureDataLakeStorageConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateAzureDataLakeStorageConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAzureDataLakeStorageConnectionDetails) String() string
func (m CreateAzureDataLakeStorageConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAzureSynapseConnectionDetails The information about a new Azure Synapse Analytics Connection.
type CreateAzureSynapseConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// JDBC connection string.
// e.g.: 'jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db-name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
ConnectionString *string `mandatory:"true" json:"connectionString"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Azure Synapse Analytics technology type.
TechnologyType AzureSynapseConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateAzureSynapseConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateAzureSynapseConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAzureSynapseConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateAzureSynapseConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateAzureSynapseConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateAzureSynapseConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAzureSynapseConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateAzureSynapseConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateAzureSynapseConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateAzureSynapseConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateAzureSynapseConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateAzureSynapseConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateAzureSynapseConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAzureSynapseConnectionDetails) String() string
func (m CreateAzureSynapseConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackupScheduleDetails Defines the backup schedule details for create operation.
type CreateBackupScheduleDetails struct {
// The start timestamp for the deployment backup schedule. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.
TimeBackupScheduled *common.SDKTime `mandatory:"true" json:"timeBackupScheduled"`
// The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
FrequencyBackupScheduled CreateBackupScheduleDetailsFrequencyBackupScheduledEnum `mandatory:"true" json:"frequencyBackupScheduled"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"true" json:"bucketName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Parameter to allow users to create backup without trails
IsMetadataOnly *bool `mandatory:"true" json:"isMetadataOnly"`
}
func (m CreateBackupScheduleDetails) String() string
func (m CreateBackupScheduleDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackupScheduleDetailsFrequencyBackupScheduledEnum Enum with underlying type: string
type CreateBackupScheduleDetailsFrequencyBackupScheduledEnum string
Set of constants representing the allowable values for CreateBackupScheduleDetailsFrequencyBackupScheduledEnum
const (
CreateBackupScheduleDetailsFrequencyBackupScheduledDaily CreateBackupScheduleDetailsFrequencyBackupScheduledEnum = "DAILY"
CreateBackupScheduleDetailsFrequencyBackupScheduledWeekly CreateBackupScheduleDetailsFrequencyBackupScheduledEnum = "WEEKLY"
CreateBackupScheduleDetailsFrequencyBackupScheduledMonthly CreateBackupScheduleDetailsFrequencyBackupScheduledEnum = "MONTHLY"
)
func GetCreateBackupScheduleDetailsFrequencyBackupScheduledEnumValues() []CreateBackupScheduleDetailsFrequencyBackupScheduledEnum
GetCreateBackupScheduleDetailsFrequencyBackupScheduledEnumValues Enumerates the set of values for CreateBackupScheduleDetailsFrequencyBackupScheduledEnum
func GetMappingCreateBackupScheduleDetailsFrequencyBackupScheduledEnum(val string) (CreateBackupScheduleDetailsFrequencyBackupScheduledEnum, bool)
GetMappingCreateBackupScheduleDetailsFrequencyBackupScheduledEnum performs case Insensitive comparison on enum value and return the desired enum
CreateCertificateDetails The information about a new Certificates.
type CreateCertificateDetails struct {
// The identifier key (unique name in the scope of the deployment) of the certificate being referenced.
// It must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
Key *string `mandatory:"true" json:"key"`
// The base64 encoded content of the PEM file containing the SSL certificate.
CertificateContent *string `mandatory:"true" json:"certificateContent"`
}
func (m CreateCertificateDetails) String() string
func (m CreateCertificateDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCertificateRequest wrapper for the CreateCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateCertificate.go.html to see an example of how to use CreateCertificateRequest.
type CreateCertificateRequest struct {
// Specifications to create the certificate to truststore.
CreateCertificateDetails `contributesTo:"body"`
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCertificateRequest) String() string
func (request CreateCertificateRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCertificateResponse wrapper for the CreateCertificate operation
type CreateCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCertificateResponse) String() string
CreateConnectionAssignmentDetails The information about a new Connection Assignment.
type CreateConnectionAssignmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
ConnectionId *string `mandatory:"true" json:"connectionId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
}
func (m CreateConnectionAssignmentDetails) String() string
func (m CreateConnectionAssignmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConnectionAssignmentRequest wrapper for the CreateConnectionAssignment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateConnectionAssignment.go.html to see an example of how to use CreateConnectionAssignmentRequest.
type CreateConnectionAssignmentRequest struct {
// Specification of the connection assignment to create.
CreateConnectionAssignmentDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateConnectionAssignmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateConnectionAssignmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateConnectionAssignmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateConnectionAssignmentRequest) String() string
func (request CreateConnectionAssignmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConnectionAssignmentResponse wrapper for the CreateConnectionAssignment operation
type CreateConnectionAssignmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The ConnectionAssignment instance
ConnectionAssignment `presentIn:"body"`
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateConnectionAssignmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConnectionAssignmentResponse) String() string
CreateConnectionDetails The information about a new Connection.
type CreateConnectionDetails interface {
// An object's Display Name.
GetDisplayName() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
GetCompartmentId() *string
// Metadata about this specific object.
GetDescription() *string
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// Locks associated with this resource.
GetLocks() []AddResourceLockDetails
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
GetVaultId() *string
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
GetKeyId() *string
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
GetNsgIds() []string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
GetSubnetId() *string
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
GetRoutingMethod() RoutingMethodEnum
// Indicates that sensitive attributes are provided via Secrets.
GetDoesUseSecretIds() *bool
}
CreateConnectionRequest wrapper for the CreateConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateConnection.go.html to see an example of how to use CreateConnectionRequest.
type CreateConnectionRequest struct {
// Specification of the Connection to create.
CreateConnectionDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateConnectionRequest) String() string
func (request CreateConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConnectionResponse wrapper for the CreateConnection operation
type CreateConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Connection instance
Connection `presentIn:"body"`
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConnectionResponse) String() string
CreateDatabaseRegistrationDetails The information about a new DatabaseRegistration.
type CreateDatabaseRegistrationDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"true" json:"fqdn"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"true" json:"password"`
// Credential store alias.
AliasName *string `mandatory:"true" json:"aliasName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The private IP address in the customer's VCN of the customer's endpoint, typically a
// database.
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode CreateDatabaseRegistrationDetailsSessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// This attribute is expected to be base64 encoded.
// Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
Wallet *string `mandatory:"false" json:"wallet"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// The OCID of the compartment where the GoldenGate Secret will be created.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
SecretCompartmentId *string `mandatory:"false" json:"secretCompartmentId"`
}
func (m CreateDatabaseRegistrationDetails) String() string
func (m CreateDatabaseRegistrationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDatabaseRegistrationDetailsSessionModeEnum Enum with underlying type: string
type CreateDatabaseRegistrationDetailsSessionModeEnum string
Set of constants representing the allowable values for CreateDatabaseRegistrationDetailsSessionModeEnum
const (
CreateDatabaseRegistrationDetailsSessionModeDirect CreateDatabaseRegistrationDetailsSessionModeEnum = "DIRECT"
CreateDatabaseRegistrationDetailsSessionModeRedirect CreateDatabaseRegistrationDetailsSessionModeEnum = "REDIRECT"
)
func GetCreateDatabaseRegistrationDetailsSessionModeEnumValues() []CreateDatabaseRegistrationDetailsSessionModeEnum
GetCreateDatabaseRegistrationDetailsSessionModeEnumValues Enumerates the set of values for CreateDatabaseRegistrationDetailsSessionModeEnum
func GetMappingCreateDatabaseRegistrationDetailsSessionModeEnum(val string) (CreateDatabaseRegistrationDetailsSessionModeEnum, bool)
GetMappingCreateDatabaseRegistrationDetailsSessionModeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDatabaseRegistrationRequest wrapper for the CreateDatabaseRegistration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateDatabaseRegistration.go.html to see an example of how to use CreateDatabaseRegistrationRequest.
type CreateDatabaseRegistrationRequest struct {
// Specification of the DatabaseRegistration to create.
CreateDatabaseRegistrationDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateDatabaseRegistrationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDatabaseRegistrationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDatabaseRegistrationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDatabaseRegistrationRequest) String() string
func (request CreateDatabaseRegistrationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDatabaseRegistrationResponse wrapper for the CreateDatabaseRegistration operation
type CreateDatabaseRegistrationResponse struct {
// The underlying http response
RawResponse *http.Response
// The DatabaseRegistration instance
DatabaseRegistration `presentIn:"body"`
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Deprecation date of this API version.
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response CreateDatabaseRegistrationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDatabaseRegistrationResponse) String() string
CreateDatabricksConnectionDetails The information about a new Databricks Connection.
type CreateDatabricksConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Connection URL.
// e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The password used to connect to Databricks.
// Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// OAuth client id, only applicable for authenticationType == OAUTH_M2M
ClientId *string `mandatory:"false" json:"clientId"`
// OAuth client secret, only applicable for authenticationType == OAUTH_M2M
// Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Only applicable for authenticationType == OAUTH_M2M.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
StorageCredentialName *string `mandatory:"false" json:"storageCredentialName"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Databricks technology type.
TechnologyType DatabricksConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Databricks.
AuthenticationType DatabricksConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m CreateDatabricksConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateDatabricksConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateDatabricksConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateDatabricksConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateDatabricksConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateDatabricksConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateDatabricksConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateDatabricksConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateDatabricksConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateDatabricksConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateDatabricksConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateDatabricksConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateDatabricksConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDatabricksConnectionDetails) String() string
func (m CreateDatabricksConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDb2ConnectionDetails The information about a new DB2 Connection.
type CreateDb2ConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The username Oracle GoldenGate uses to connect to the DB2 database.
// This username must already exist and be available by the DB2 to be connected to.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The password Oracle GoldenGate uses to connect the associated DB2 database.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated DB2 database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The base64 encoded keystore file created at the client containing the server certificate / CA root certificate.
// Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
SslClientKeystoredb *string `mandatory:"false" json:"sslClientKeystoredb"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored,
// which created at the client containing the server certificate / CA root certificate.
// Note: When provided, 'sslClientKeystoredb' field must not be provided.
SslClientKeystoredbSecretId *string `mandatory:"false" json:"sslClientKeystoredbSecretId"`
// The base64 encoded keystash file which contains the encrypted password to the key database file.
// Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
SslClientKeystash *string `mandatory:"false" json:"sslClientKeystash"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored,
// which contains the encrypted password to the key database file.
// Note: When provided, 'sslClientKeystash' field must not be provided.
SslClientKeystashSecretId *string `mandatory:"false" json:"sslClientKeystashSecretId"`
// The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
SslServerCertificate *string `mandatory:"false" json:"sslServerCertificate"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The DB2 technology type.
TechnologyType Db2ConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for the DB2 database.
SecurityProtocol Db2ConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
}
func (m CreateDb2ConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateDb2ConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateDb2ConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateDb2ConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateDb2ConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateDb2ConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateDb2ConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateDb2ConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateDb2ConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateDb2ConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateDb2ConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateDb2ConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateDb2ConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDb2ConnectionDetails) String() string
func (m CreateDb2ConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDeploymentBackupDetails The information about a new DeploymentBackup.
type CreateDeploymentBackupDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"true" json:"bucketName"`
// Name of the object to be uploaded to object storage
ObjectName *string `mandatory:"true" json:"objectName"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Parameter to allow users to create backup without trails
IsMetadataOnly *bool `mandatory:"false" json:"isMetadataOnly"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
}
func (m CreateDeploymentBackupDetails) String() string
func (m CreateDeploymentBackupDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDeploymentBackupRequest wrapper for the CreateDeploymentBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateDeploymentBackup.go.html to see an example of how to use CreateDeploymentBackupRequest.
type CreateDeploymentBackupRequest struct {
// Specification of the DeploymentBackup to create.
CreateDeploymentBackupDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateDeploymentBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDeploymentBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDeploymentBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDeploymentBackupRequest) String() string
func (request CreateDeploymentBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDeploymentBackupResponse wrapper for the CreateDeploymentBackup operation
type CreateDeploymentBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentBackup instance
DeploymentBackup `presentIn:"body"`
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateDeploymentBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDeploymentBackupResponse) String() string
CreateDeploymentDetails The information about a new Deployment.
type CreateDeploymentDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"true" json:"licenseModel"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the deployment's private endpoint.
// The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,
// after which the private subnet will be enforced.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The Minimum number of OCPUs to be made available for this Deployment.
CpuCoreCount *int `mandatory:"true" json:"cpuCoreCount"`
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
// The type of deployment, which can be any one of the Allowed values.
// NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes.
// Its use is discouraged in favor of 'DATABASE_ORACLE'.
DeploymentType DeploymentTypeEnum `mandatory:"true" json:"deploymentType"`
// Specifies whether the deployment is used in a production or development/testing environment.
EnvironmentType EnvironmentTypeEnum `mandatory:"false" json:"environmentType,omitempty"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.
DeploymentBackupId *string `mandatory:"false" json:"deploymentBackupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy.
// Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy.
// For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
LoadBalancerSubnetId *string `mandatory:"false" json:"loadBalancerSubnetId"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"false" json:"fqdn"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// True if this object is publicly available.
IsPublic *bool `mandatory:"false" json:"isPublic"`
OggData *CreateOggDeploymentDetails `mandatory:"false" json:"oggData"`
MaintenanceWindow *CreateMaintenanceWindowDetails `mandatory:"false" json:"maintenanceWindow"`
MaintenanceConfiguration *CreateMaintenanceConfigurationDetails `mandatory:"false" json:"maintenanceConfiguration"`
BackupSchedule *CreateBackupScheduleDetails `mandatory:"false" json:"backupSchedule"`
}
func (m CreateDeploymentDetails) String() string
func (m CreateDeploymentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDeploymentRequest wrapper for the CreateDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateDeployment.go.html to see an example of how to use CreateDeploymentRequest.
type CreateDeploymentRequest struct {
// Specifications to create the Deployment.
CreateDeploymentDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDeploymentRequest) String() string
func (request CreateDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDeploymentResponse wrapper for the CreateDeployment operation
type CreateDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The Deployment instance
Deployment `presentIn:"body"`
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDeploymentResponse) String() string
CreateElasticsearchConnectionDetails The information about a new Elasticsearch Connection.
type CreateElasticsearchConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 9200.
// Used for establishing the initial connection to the Elasticsearch cluster.
// Example: `"server1.example.com:4000,server2.example.com:4000"`
Servers *string `mandatory:"true" json:"servers"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Fingerprint required by TLS security protocol.
// Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
Fingerprint *string `mandatory:"false" json:"fingerprint"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Elasticsearch technology type.
TechnologyType ElasticsearchConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Elasticsearch.
SecurityProtocol ElasticsearchConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Authentication type for Elasticsearch.
AuthenticationType ElasticsearchConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m CreateElasticsearchConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateElasticsearchConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateElasticsearchConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateElasticsearchConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateElasticsearchConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateElasticsearchConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateElasticsearchConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateElasticsearchConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateElasticsearchConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateElasticsearchConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateElasticsearchConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateElasticsearchConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateElasticsearchConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateElasticsearchConnectionDetails) String() string
func (m CreateElasticsearchConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGenericConnectionDetails The information about a new Generic Connection.
type CreateGenericConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Host and port separated by colon.
// Example: `"server.example.com:1234"`
// For multiple hosts, provide a comma separated list.
// Example: `"server1.example.com:1000,server1.example.com:2000"`
Host *string `mandatory:"true" json:"host"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Generic technology type.
TechnologyType GenericConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateGenericConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateGenericConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateGenericConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateGenericConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateGenericConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateGenericConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateGenericConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateGenericConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateGenericConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateGenericConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateGenericConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateGenericConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateGenericConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateGenericConnectionDetails) String() string
func (m CreateGenericConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGoldenGateConnectionDetails The information about a new GoldenGate Connection.
type CreateGoldenGateConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"false" json:"deploymentId"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The username credential existing in the Oracle GoldenGate used to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password used to connect to the Oracle GoldenGate accessed trough this connection.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// which is used to connect to the Oracle GoldenGate accessed trough this connection.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The GoldenGate technology type.
TechnologyType GoldenGateConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateGoldenGateConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateGoldenGateConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateGoldenGateConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateGoldenGateConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateGoldenGateConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateGoldenGateConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateGoldenGateConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateGoldenGateConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateGoldenGateConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateGoldenGateConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateGoldenGateConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateGoldenGateConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateGoldenGateConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateGoldenGateConnectionDetails) String() string
func (m CreateGoldenGateConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGoogleBigQueryConnectionDetails The information about a new Google BigQuery Connection.
type CreateGoogleBigQueryConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The base64 encoded content of the service account key file containing
// the credentials required to use Google BigQuery.
// Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
ServiceAccountKeyFile *string `mandatory:"false" json:"serviceAccountKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google BigQuery.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Google BigQuery technology type.
TechnologyType GoogleBigQueryConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateGoogleBigQueryConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateGoogleBigQueryConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateGoogleBigQueryConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateGoogleBigQueryConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateGoogleBigQueryConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateGoogleBigQueryConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateGoogleBigQueryConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateGoogleBigQueryConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateGoogleBigQueryConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateGoogleBigQueryConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateGoogleBigQueryConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateGoogleBigQueryConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateGoogleBigQueryConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateGoogleBigQueryConnectionDetails) String() string
func (m CreateGoogleBigQueryConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGoogleCloudStorageConnectionDetails The information about a new Google Cloud Storage Connection.
type CreateGoogleCloudStorageConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The base64 encoded content of the service account key file containing
// the credentials required to use Google Cloud Storage.
// Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
ServiceAccountKeyFile *string `mandatory:"false" json:"serviceAccountKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google Cloud Storage.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Google Cloud Storage technology type.
TechnologyType GoogleCloudStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateGoogleCloudStorageConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateGoogleCloudStorageConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateGoogleCloudStorageConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateGoogleCloudStorageConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateGoogleCloudStorageConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateGoogleCloudStorageConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateGoogleCloudStorageConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateGoogleCloudStorageConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateGoogleCloudStorageConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateGoogleCloudStorageConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateGoogleCloudStorageConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateGoogleCloudStorageConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateGoogleCloudStorageConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateGoogleCloudStorageConnectionDetails) String() string
func (m CreateGoogleCloudStorageConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGooglePubSubConnectionDetails The information about a new Google PubSub Connection.
type CreateGooglePubSubConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The base64 encoded content of the service account key file containing
// the credentials required to use Google PubSub.
// Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
ServiceAccountKeyFile *string `mandatory:"true" json:"serviceAccountKeyFile"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google PubSub.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Google PubSub technology type.
TechnologyType GooglePubSubConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateGooglePubSubConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateGooglePubSubConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateGooglePubSubConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateGooglePubSubConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateGooglePubSubConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateGooglePubSubConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateGooglePubSubConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateGooglePubSubConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateGooglePubSubConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateGooglePubSubConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateGooglePubSubConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateGooglePubSubConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateGooglePubSubConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateGooglePubSubConnectionDetails) String() string
func (m CreateGooglePubSubConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateHdfsConnectionDetails The information about a new Hadoop Distributed File System Connection.
type CreateHdfsConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
CoreSiteXml *string `mandatory:"true" json:"coreSiteXml"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Hadoop Distributed File System technology type.
TechnologyType HdfsConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateHdfsConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateHdfsConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateHdfsConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateHdfsConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateHdfsConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateHdfsConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateHdfsConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateHdfsConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateHdfsConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateHdfsConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateHdfsConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateHdfsConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateHdfsConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateHdfsConnectionDetails) String() string
func (m CreateHdfsConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateJavaMessageServiceConnectionDetails The information about a new Java Message Service Connection.
type CreateJavaMessageServiceConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
ShouldUseJndi *bool `mandatory:"true" json:"shouldUseJndi"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The Connection Factory can be looked up using this name.
// e.g.: 'ConnectionFactory'
JndiConnectionFactory *string `mandatory:"false" json:"jndiConnectionFactory"`
// The URL that Java Message Service will use to contact the JNDI provider.
// e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
JndiProviderUrl *string `mandatory:"false" json:"jndiProviderUrl"`
// The implementation of javax.naming.spi.InitialContextFactory interface
// that the client uses to obtain initial naming context.
// e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
JndiInitialContextFactory *string `mandatory:"false" json:"jndiInitialContextFactory"`
// Specifies the identity of the principal (user) to be authenticated.
// e.g.: 'admin2'
JndiSecurityPrincipal *string `mandatory:"false" json:"jndiSecurityPrincipal"`
// The password associated to the principal.
// Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
JndiSecurityCredentials *string `mandatory:"false" json:"jndiSecurityCredentials"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal.
// Note: When provided, 'jndiSecurityCredentials' field must not be provided.
JndiSecurityCredentialsSecretId *string `mandatory:"false" json:"jndiSecurityCredentialsSecretId"`
// Connectin URL of the Java Message Service, specifying the protocol, host, and port.
// e.g.: 'mq://myjms.host.domain:7676'
ConnectionUrl *string `mandatory:"false" json:"connectionUrl"`
// The of Java class implementing javax.jms.ConnectionFactory interface
// supplied by the Java Message Service provider.
// e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
ConnectionFactory *string `mandatory:"false" json:"connectionFactory"`
// The username Oracle GoldenGate uses to connect to the Java Message Service.
// This username must already exist and be available by the Java Message Service to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated Java Message Service.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated Java Message Service.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The password for the cert inside of the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
SslKeyPassword *string `mandatory:"false" json:"sslKeyPassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored for the cert inside of the Keystore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Java Message Service technology type.
TechnologyType JavaMessageServiceConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Java Message Service. If not provided, default is PLAIN.
// Optional until 2024-06-27, in the release after it will be made required.
SecurityProtocol JavaMessageServiceConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Authentication type for Java Message Service. If not provided, default is NONE.
// Optional until 2024-06-27, in the release after it will be made required.
AuthenticationType JavaMessageServiceConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m CreateJavaMessageServiceConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateJavaMessageServiceConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateJavaMessageServiceConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateJavaMessageServiceConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateJavaMessageServiceConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateJavaMessageServiceConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateJavaMessageServiceConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateJavaMessageServiceConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateJavaMessageServiceConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateJavaMessageServiceConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateJavaMessageServiceConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateJavaMessageServiceConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateJavaMessageServiceConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateJavaMessageServiceConnectionDetails) String() string
func (m CreateJavaMessageServiceConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateKafkaConnectionDetails The information about a new Kafka Connection.
type CreateKafkaConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced.
StreamPoolId *string `mandatory:"false" json:"streamPoolId"`
// Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka:
// list of KafkaBootstrapServer objects specified by host/port.
// Used for establishing the initial connection to the Kafka cluster.
// Example: `"server1.example.com:9092,server2.example.com:9092"`
BootstrapServers []KafkaBootstrapServer `mandatory:"false" json:"bootstrapServers"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The password for the cert inside of the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
SslKeyPassword *string `mandatory:"false" json:"sslKeyPassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// The base64 encoded content of the consumer.properties file.
ConsumerProperties *string `mandatory:"false" json:"consumerProperties"`
// The base64 encoded content of the producer.properties file.
ProducerProperties *string `mandatory:"false" json:"producerProperties"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Kafka technology type.
TechnologyType KafkaConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for Kafka.
SecurityProtocol KafkaConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m CreateKafkaConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateKafkaConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateKafkaConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateKafkaConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateKafkaConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateKafkaConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateKafkaConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateKafkaConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateKafkaConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateKafkaConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateKafkaConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateKafkaConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateKafkaConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateKafkaConnectionDetails) String() string
func (m CreateKafkaConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateKafkaSchemaRegistryConnectionDetails The information about a new Kafka (e.g. Confluent) Schema Registry Connection.
type CreateKafkaSchemaRegistryConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Kafka Schema Registry URL.
// e.g.: 'https://server1.us.oracle.com:8081'
Url *string `mandatory:"true" json:"url"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
Username *string `mandatory:"false" json:"username"`
// The password to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Kafka Schema Registry password is stored,
// The password to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The password for the cert inside the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
SslKeyPassword *string `mandatory:"false" json:"sslKeyPassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the cert inside the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Kafka (e.g. Confluent) Schema Registry technology type.
TechnologyType KafkaSchemaRegistryConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Schema Registry.
AuthenticationType KafkaSchemaRegistryConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m CreateKafkaSchemaRegistryConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateKafkaSchemaRegistryConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateKafkaSchemaRegistryConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateKafkaSchemaRegistryConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateKafkaSchemaRegistryConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateKafkaSchemaRegistryConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateKafkaSchemaRegistryConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateKafkaSchemaRegistryConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateKafkaSchemaRegistryConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateKafkaSchemaRegistryConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateKafkaSchemaRegistryConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateKafkaSchemaRegistryConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateKafkaSchemaRegistryConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateKafkaSchemaRegistryConnectionDetails) String() string
func (m CreateKafkaSchemaRegistryConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMaintenanceConfigurationDetails Defines the maintenance configuration for create operation.
type CreateMaintenanceConfigurationDetails struct {
// By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release,
// you have to specify interimReleaseUpgradePeriodInDays too.
IsInterimReleaseAutoUpgradeEnabled *bool `mandatory:"false" json:"isInterimReleaseAutoUpgradeEnabled"`
// Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
InterimReleaseUpgradePeriodInDays *int `mandatory:"false" json:"interimReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases.
// This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
BundleReleaseUpgradePeriodInDays *int `mandatory:"false" json:"bundleReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases.
// Not passing this field during create will equate to using the service default.
MajorReleaseUpgradePeriodInDays *int `mandatory:"false" json:"majorReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases.
// Not passing this field during create will equate to using the service default.
SecurityPatchUpgradePeriodInDays *int `mandatory:"false" json:"securityPatchUpgradePeriodInDays"`
}
func (m CreateMaintenanceConfigurationDetails) String() string
func (m CreateMaintenanceConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMaintenanceWindowDetails Defines the maintenance window for create operation, when automatic actions can be performed.
type CreateMaintenanceWindowDetails struct {
// Days of the week.
Day DayEnum `mandatory:"true" json:"day"`
// Start hour for maintenance period. Hour is in UTC.
StartHour *int `mandatory:"true" json:"startHour"`
}
func (m CreateMaintenanceWindowDetails) String() string
func (m CreateMaintenanceWindowDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMicrosoftFabricConnectionDetails The information about a new Microsoft Fabric Connection.
type CreateMicrosoftFabricConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Azure tenant ID of the application.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
TenantId *string `mandatory:"true" json:"tenantId"`
// Azure client ID of the application.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"true" json:"clientId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Client secret associated with the client id.
// Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional Microsoft Fabric service endpoint.
// Default value: https://onelake.dfs.fabric.microsoft.com
Endpoint *string `mandatory:"false" json:"endpoint"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Microsoft Fabric technology type.
TechnologyType MicrosoftFabricConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateMicrosoftFabricConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateMicrosoftFabricConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMicrosoftFabricConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateMicrosoftFabricConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateMicrosoftFabricConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateMicrosoftFabricConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMicrosoftFabricConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateMicrosoftFabricConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateMicrosoftFabricConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateMicrosoftFabricConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateMicrosoftFabricConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateMicrosoftFabricConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateMicrosoftFabricConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMicrosoftFabricConnectionDetails) String() string
func (m CreateMicrosoftFabricConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMicrosoftSqlserverConnectionDetails The information about a new Microsoft SQL Server Connection.
type CreateMicrosoftSqlserverConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The username Oracle GoldenGate uses to connect to the Microsoft SQL Server.
// This username must already exist and be available by the Microsoft SQL Server to be connected to.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// Database Certificate - The base64 encoded content of a .pem or .crt file.
// containing the server public key (for 1-way SSL).
SslCa *string `mandatory:"false" json:"sslCa"`
// If set to true, the driver validates the certificate that is sent by the database server.
ShouldValidateServerCertificate *bool `mandatory:"false" json:"shouldValidateServerCertificate"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Microsoft SQL Server technology type.
TechnologyType MicrosoftSqlserverConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for Microsoft SQL Server.
SecurityProtocol MicrosoftSqlserverConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
}
func (m CreateMicrosoftSqlserverConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateMicrosoftSqlserverConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMicrosoftSqlserverConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateMicrosoftSqlserverConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateMicrosoftSqlserverConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateMicrosoftSqlserverConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMicrosoftSqlserverConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateMicrosoftSqlserverConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateMicrosoftSqlserverConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateMicrosoftSqlserverConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateMicrosoftSqlserverConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateMicrosoftSqlserverConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateMicrosoftSqlserverConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMicrosoftSqlserverConnectionDetails) String() string
func (m CreateMicrosoftSqlserverConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMongoDbConnectionDetails The information about a new MongoDB Connection.
type CreateMongoDbConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// MongoDB connection string.
// e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The username Oracle GoldenGate uses to connect to the database.
// This username must already exist and be available by the database to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated database.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
TlsCaFile *string `mandatory:"false" json:"tlsCaFile"`
// Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL).
// Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
TlsCertificateKeyFile *string `mandatory:"false" json:"tlsCertificateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection.
// - The content of a .pem file containing the client private key (for 2-way SSL).
// Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
TlsCertificateKeyFileSecretId *string `mandatory:"false" json:"tlsCertificateKeyFileSecretId"`
// Client Certificate key file password.
// Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
TlsCertificateKeyFilePassword *string `mandatory:"false" json:"tlsCertificateKeyFilePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file.
// Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
TlsCertificateKeyFilePasswordSecretId *string `mandatory:"false" json:"tlsCertificateKeyFilePasswordSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The MongoDB technology type.
TechnologyType MongoDbConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for MongoDB.
SecurityProtocol MongoDbConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m CreateMongoDbConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateMongoDbConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMongoDbConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateMongoDbConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateMongoDbConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateMongoDbConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMongoDbConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateMongoDbConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateMongoDbConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateMongoDbConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateMongoDbConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateMongoDbConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateMongoDbConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMongoDbConnectionDetails) String() string
func (m CreateMongoDbConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMysqlConnectionDetails The information about a new MySQL Connection.
type CreateMysqlConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// Database Certificate - The base64 encoded content of a .pem or .crt file.
// containing the server public key (for 1 and 2-way SSL).
SslCa *string `mandatory:"false" json:"sslCa"`
// The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
// Note: This is an optional property and only applicable if TLS/MTLS option is selected.
SslCrl *string `mandatory:"false" json:"sslCrl"`
// Client Certificate - The base64 encoded content of a .pem or .crt file.
// containing the client public key (for 2-way SSL).
SslCert *string `mandatory:"false" json:"sslCert"`
// Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).
// Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
SslKey *string `mandatory:"false" json:"sslKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the Client Key
// - The content of a .pem or .crt file containing the client private key (for 2-way SSL).
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The MySQL technology type.
TechnologyType MysqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for MySQL.
SecurityProtocol MysqlConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// SSL modes for MySQL.
SslMode MysqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
}
func (m CreateMysqlConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateMysqlConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMysqlConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateMysqlConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateMysqlConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateMysqlConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMysqlConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateMysqlConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateMysqlConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateMysqlConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateMysqlConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateMysqlConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateMysqlConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMysqlConnectionDetails) String() string
func (m CreateMysqlConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateOciObjectStorageConnectionDetails The information about a new OCI Object Storage Connection.
type CreateOciObjectStorageConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Object Storage.
// The user must have write access to the bucket they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"false" json:"userId"`
// The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
PrivateKeyFile *string `mandatory:"false" json:"privateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The passphrase of the private key.
// Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
PrivateKeyPassphrase *string `mandatory:"false" json:"privateKeyPassphrase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// The fingerprint of the API Key of the user specified by the userId.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
PublicKeyFingerprint *string `mandatory:"false" json:"publicKeyFingerprint"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The OCI Object Storage technology type.
TechnologyType OciObjectStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateOciObjectStorageConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateOciObjectStorageConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOciObjectStorageConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateOciObjectStorageConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateOciObjectStorageConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateOciObjectStorageConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOciObjectStorageConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateOciObjectStorageConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateOciObjectStorageConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateOciObjectStorageConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateOciObjectStorageConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateOciObjectStorageConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateOciObjectStorageConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOciObjectStorageConnectionDetails) String() string
func (m CreateOciObjectStorageConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateOggDeploymentDetails Deployment Data for creating an OggDeployment
type CreateOggDeploymentDetails struct {
// The name given to the GoldenGate service deployment.
// The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
DeploymentName *string `mandatory:"true" json:"deploymentName"`
// The type of credential store for OGG.
CredentialStore CredentialStoreEnum `mandatory:"false" json:"credentialStore,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.
IdentityDomainId *string `mandatory:"false" json:"identityDomainId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The GoldenGate deployment console username.
AdminUsername *string `mandatory:"false" json:"adminUsername"`
// The password associated with the GoldenGate deployment console username.
// The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric,
// and 1 special character. Special characters such as '$', '^', or '?' are not allowed.
// This field will be deprecated and replaced by "passwordSecretId".
AdminPassword *string `mandatory:"false" json:"adminPassword"`
// The base64 encoded content of the PEM file containing the SSL certificate.
Certificate *string `mandatory:"false" json:"certificate"`
// The base64 encoded content of the PEM file containing the private key.
Key *string `mandatory:"false" json:"key"`
// Version of OGG
OggVersion *string `mandatory:"false" json:"oggVersion"`
GroupToRolesMapping *GroupToRolesMappingDetails `mandatory:"false" json:"groupToRolesMapping"`
}
func (m CreateOggDeploymentDetails) String() string
func (m CreateOggDeploymentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateOracleConnectionDetails The information about a new Oracle Database Connection.
type CreateOracleConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// This attribute is expected to be base64 encoded.
// Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
Wallet *string `mandatory:"false" json:"wallet"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored.
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// Note: When provided, 'wallet' field must not be provided.
WalletSecretId *string `mandatory:"false" json:"walletSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Oracle technology type.
TechnologyType OracleConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections,
// when a databaseId is provided. The default value is MTLS.
AuthenticationMode OracleConnectionAuthenticationModeEnum `mandatory:"false" json:"authenticationMode,omitempty"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode OracleConnectionSessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
}
func (m CreateOracleConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateOracleConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOracleConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateOracleConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateOracleConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateOracleConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOracleConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateOracleConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateOracleConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateOracleConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateOracleConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateOracleConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateOracleConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOracleConnectionDetails) String() string
func (m CreateOracleConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateOracleNosqlConnectionDetails The information about a new Oracle NoSQL Connection.
type CreateOracleNosqlConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Oracle NoSQL database.
// The user must have write access to the table they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"false" json:"userId"`
// The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
PrivateKeyFile *string `mandatory:"false" json:"privateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The passphrase of the private key.
// Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
PrivateKeyPassphrase *string `mandatory:"false" json:"privateKeyPassphrase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// The fingerprint of the API Key of the user specified by the userId.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
PublicKeyFingerprint *string `mandatory:"false" json:"publicKeyFingerprint"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Oracle NoSQL technology type.
TechnologyType OracleNosqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m CreateOracleNosqlConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateOracleNosqlConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOracleNosqlConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateOracleNosqlConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateOracleNosqlConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateOracleNosqlConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOracleNosqlConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateOracleNosqlConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateOracleNosqlConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateOracleNosqlConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateOracleNosqlConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateOracleNosqlConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateOracleNosqlConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOracleNosqlConnectionDetails) String() string
func (m CreateOracleNosqlConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePipelineDetails Details with which to create a pipeline.
type CreatePipelineDetails interface {
// An object's Display Name.
GetDisplayName() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
GetCompartmentId() *string
// The Oracle license model that applies to a Deployment.
GetLicenseModel() LicenseModelEnum
GetSourceConnectionDetails() *SourcePipelineConnectionDetails
GetTargetConnectionDetails() *TargetPipelineConnectionDetails
// Metadata about this specific object.
GetDescription() *string
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// Locks associated with this resource.
GetLocks() []ResourceLock
}
CreatePipelineRequest wrapper for the CreatePipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreatePipeline.go.html to see an example of how to use CreatePipelineRequest.
type CreatePipelineRequest struct {
// Specification of the pipeline to create.
CreatePipelineDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreatePipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePipelineRequest) String() string
func (request CreatePipelineRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePipelineResponse wrapper for the CreatePipeline operation
type CreatePipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// The Pipeline instance
Pipeline `presentIn:"body"`
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreatePipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePipelineResponse) String() string
CreatePostgresqlConnectionDetails The information about a new PostgreSQL Connection.
type CreatePostgresqlConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.
// The supported file formats are .pem and .crt.
SslCa *string `mandatory:"false" json:"sslCa"`
// The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
SslCrl *string `mandatory:"false" json:"sslCrl"`
// The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt.
SslCert *string `mandatory:"false" json:"sslCert"`
// The base64 encoded private key of the PostgreSQL server. The supported file formats are .pem and .crt.
// Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
SslKey *string `mandatory:"false" json:"sslKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt.
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The PostgreSQL technology type.
TechnologyType PostgresqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for PostgreSQL.
SecurityProtocol PostgresqlConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// SSL modes for PostgreSQL.
SslMode PostgresqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
}
func (m CreatePostgresqlConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreatePostgresqlConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreatePostgresqlConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreatePostgresqlConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreatePostgresqlConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreatePostgresqlConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreatePostgresqlConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreatePostgresqlConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreatePostgresqlConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreatePostgresqlConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreatePostgresqlConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreatePostgresqlConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreatePostgresqlConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreatePostgresqlConnectionDetails) String() string
func (m CreatePostgresqlConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRedisConnectionDetails The information about a new Redis Connection.
type CreateRedisConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 6379.
// Used for establishing the initial connection to the Redis cluster.
// Example: `"server1.example.com:6379,server2.example.com:6379"`
Servers *string `mandatory:"false" json:"servers"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Redis cluster.
RedisClusterId *string `mandatory:"false" json:"redisClusterId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Redis technology type.
TechnologyType RedisConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Redis.
SecurityProtocol RedisConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Authenticationentication type for the Redis database.
AuthenticationType RedisConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m CreateRedisConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateRedisConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateRedisConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateRedisConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateRedisConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateRedisConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateRedisConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateRedisConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateRedisConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateRedisConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateRedisConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateRedisConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateRedisConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateRedisConnectionDetails) String() string
func (m CreateRedisConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSnowflakeConnectionDetails The information about a new Snowflake Connection.
type CreateSnowflakeConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// JDBC connection URL.
// e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []AddResourceLockDetails `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect to Snowflake.
// This username must already exist and be available by Snowflake platform to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect to Snowflake platform.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of private key file in PEM format.
// Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
PrivateKeyFile *string `mandatory:"false" json:"privateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// Password if the private key file is encrypted.
// Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
PrivateKeyPassphrase *string `mandatory:"false" json:"privateKeyPassphrase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the private key file.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Snowflake technology type.
TechnologyType SnowflakeConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Snowflake.
AuthenticationType SnowflakeConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m CreateSnowflakeConnectionDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateSnowflakeConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateSnowflakeConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateSnowflakeConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateSnowflakeConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m CreateSnowflakeConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateSnowflakeConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m CreateSnowflakeConnectionDetails) GetLocks() []AddResourceLockDetails
GetLocks returns Locks
func (m CreateSnowflakeConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m CreateSnowflakeConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m CreateSnowflakeConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m CreateSnowflakeConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m CreateSnowflakeConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSnowflakeConnectionDetails) String() string
func (m CreateSnowflakeConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateZeroEtlPipelineDetails Creation details for a new ZeroETL pipeline.
type CreateZeroEtlPipelineDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
SourceConnectionDetails *SourcePipelineConnectionDetails `mandatory:"true" json:"sourceConnectionDetails"`
TargetConnectionDetails *TargetPipelineConnectionDetails `mandatory:"true" json:"targetConnectionDetails"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
ProcessOptions *ProcessOptions `mandatory:"false" json:"processOptions"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"true" json:"licenseModel"`
}
func (m CreateZeroEtlPipelineDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateZeroEtlPipelineDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateZeroEtlPipelineDetails) GetDescription() *string
GetDescription returns Description
func (m CreateZeroEtlPipelineDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateZeroEtlPipelineDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateZeroEtlPipelineDetails) GetLicenseModel() LicenseModelEnum
GetLicenseModel returns LicenseModel
func (m CreateZeroEtlPipelineDetails) GetLocks() []ResourceLock
GetLocks returns Locks
func (m CreateZeroEtlPipelineDetails) GetSourceConnectionDetails() *SourcePipelineConnectionDetails
GetSourceConnectionDetails returns SourceConnectionDetails
func (m CreateZeroEtlPipelineDetails) GetTargetConnectionDetails() *TargetPipelineConnectionDetails
GetTargetConnectionDetails returns TargetConnectionDetails
func (m CreateZeroEtlPipelineDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateZeroEtlPipelineDetails) String() string
func (m CreateZeroEtlPipelineDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CredentialStoreEnum Enum with underlying type: string
type CredentialStoreEnum string
Set of constants representing the allowable values for CredentialStoreEnum
const (
CredentialStoreGoldengate CredentialStoreEnum = "GOLDENGATE"
CredentialStoreIam CredentialStoreEnum = "IAM"
)
func GetCredentialStoreEnumValues() []CredentialStoreEnum
GetCredentialStoreEnumValues Enumerates the set of values for CredentialStoreEnum
func GetMappingCredentialStoreEnum(val string) (CredentialStoreEnum, bool)
GetMappingCredentialStoreEnum performs case Insensitive comparison on enum value and return the desired enum
DatabaseRegistration Represents the metadata description of a database used by deployments in the same compartment.
type DatabaseRegistration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the databaseRegistration being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"true" json:"fqdn"`
// The private IP address in the customer's VCN of the customer's endpoint, typically a
// database.
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Credential store alias.
AliasName *string `mandatory:"true" json:"aliasName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// A Private Endpoint IP address created in the customer's subnet.
// A customer database can expect network traffic initiated by GoldenGate Service from this IP address.
// It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service.
// The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
RcePrivateIp *string `mandatory:"false" json:"rcePrivateIp"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode DatabaseRegistrationSessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// The OCID of the compartment where the GoldenGate Secret will be created.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
SecretCompartmentId *string `mandatory:"false" json:"secretCompartmentId"`
// The OCID of the customer's GoldenGate Service Secret.
// If provided, it references a key that customers will be required to ensure the policies are established
// to permit GoldenGate to use this Secret.
SecretId *string `mandatory:"false" json:"secretId"`
}
func (m DatabaseRegistration) String() string
func (m DatabaseRegistration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatabaseRegistrationCollection A list of DatabaseRegistrations.
type DatabaseRegistrationCollection struct {
// An array of DatabaseRegistration summaries.
Items []DatabaseRegistrationSummary `mandatory:"true" json:"items"`
}
func (m DatabaseRegistrationCollection) String() string
func (m DatabaseRegistrationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatabaseRegistrationSessionModeEnum Enum with underlying type: string
type DatabaseRegistrationSessionModeEnum string
Set of constants representing the allowable values for DatabaseRegistrationSessionModeEnum
const (
DatabaseRegistrationSessionModeDirect DatabaseRegistrationSessionModeEnum = "DIRECT"
DatabaseRegistrationSessionModeRedirect DatabaseRegistrationSessionModeEnum = "REDIRECT"
)
func GetDatabaseRegistrationSessionModeEnumValues() []DatabaseRegistrationSessionModeEnum
GetDatabaseRegistrationSessionModeEnumValues Enumerates the set of values for DatabaseRegistrationSessionModeEnum
func GetMappingDatabaseRegistrationSessionModeEnum(val string) (DatabaseRegistrationSessionModeEnum, bool)
GetMappingDatabaseRegistrationSessionModeEnum performs case Insensitive comparison on enum value and return the desired enum
DatabaseRegistrationSummary Summary of the DatabaseRegistration.
type DatabaseRegistrationSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the databaseRegistration being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"true" json:"fqdn"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode DatabaseRegistrationSummarySessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
// Credential store alias.
AliasName *string `mandatory:"false" json:"aliasName"`
// The OCID of the customer's GoldenGate Service Secret.
// If provided, it references a key that customers will be required to ensure the policies are established
// to permit GoldenGate to use this Secret.
SecretId *string `mandatory:"false" json:"secretId"`
}
func (m DatabaseRegistrationSummary) String() string
func (m DatabaseRegistrationSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatabaseRegistrationSummarySessionModeEnum Enum with underlying type: string
type DatabaseRegistrationSummarySessionModeEnum string
Set of constants representing the allowable values for DatabaseRegistrationSummarySessionModeEnum
const (
DatabaseRegistrationSummarySessionModeDirect DatabaseRegistrationSummarySessionModeEnum = "DIRECT"
DatabaseRegistrationSummarySessionModeRedirect DatabaseRegistrationSummarySessionModeEnum = "REDIRECT"
)
func GetDatabaseRegistrationSummarySessionModeEnumValues() []DatabaseRegistrationSummarySessionModeEnum
GetDatabaseRegistrationSummarySessionModeEnumValues Enumerates the set of values for DatabaseRegistrationSummarySessionModeEnum
func GetMappingDatabaseRegistrationSummarySessionModeEnum(val string) (DatabaseRegistrationSummarySessionModeEnum, bool)
GetMappingDatabaseRegistrationSummarySessionModeEnum performs case Insensitive comparison on enum value and return the desired enum
DatabricksConnection Represents the metadata of a Databricks Connection.
type DatabricksConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Connection URL.
// e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// OAuth client id, only applicable for authenticationType == OAUTH_M2M
ClientId *string `mandatory:"false" json:"clientId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Only applicable for authenticationType == OAUTH_M2M.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
StorageCredentialName *string `mandatory:"false" json:"storageCredentialName"`
// The Databricks technology type.
TechnologyType DatabricksConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Databricks.
// Required fields by authentication types:
// - PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
// - OAUTH_M2M: user must enter clientId and clientSecret
AuthenticationType DatabricksConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m DatabricksConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m DatabricksConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m DatabricksConnection) GetDescription() *string
GetDescription returns Description
func (m DatabricksConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m DatabricksConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m DatabricksConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m DatabricksConnection) GetId() *string
GetId returns Id
func (m DatabricksConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m DatabricksConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m DatabricksConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m DatabricksConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m DatabricksConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m DatabricksConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m DatabricksConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m DatabricksConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m DatabricksConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m DatabricksConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m DatabricksConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m DatabricksConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m DatabricksConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DatabricksConnection) String() string
func (m DatabricksConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatabricksConnectionAuthenticationTypeEnum Enum with underlying type: string
type DatabricksConnectionAuthenticationTypeEnum string
Set of constants representing the allowable values for DatabricksConnectionAuthenticationTypeEnum
const (
DatabricksConnectionAuthenticationTypePersonalAccessToken DatabricksConnectionAuthenticationTypeEnum = "PERSONAL_ACCESS_TOKEN"
DatabricksConnectionAuthenticationTypeOauthM2m DatabricksConnectionAuthenticationTypeEnum = "OAUTH_M2M"
)
func GetDatabricksConnectionAuthenticationTypeEnumValues() []DatabricksConnectionAuthenticationTypeEnum
GetDatabricksConnectionAuthenticationTypeEnumValues Enumerates the set of values for DatabricksConnectionAuthenticationTypeEnum
func GetMappingDatabricksConnectionAuthenticationTypeEnum(val string) (DatabricksConnectionAuthenticationTypeEnum, bool)
GetMappingDatabricksConnectionAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DatabricksConnectionSummary Summary of the Databricks Connection.
type DatabricksConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Connection URL.
// e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// OAuth client id, only applicable for authenticationType == OAUTH_M2M
ClientId *string `mandatory:"false" json:"clientId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Only applicable for authenticationType == OAUTH_M2M.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
StorageCredentialName *string `mandatory:"false" json:"storageCredentialName"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Databricks technology type.
TechnologyType DatabricksConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Databricks.
AuthenticationType DatabricksConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m DatabricksConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m DatabricksConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m DatabricksConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m DatabricksConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m DatabricksConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m DatabricksConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m DatabricksConnectionSummary) GetId() *string
GetId returns Id
func (m DatabricksConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m DatabricksConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m DatabricksConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m DatabricksConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m DatabricksConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m DatabricksConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m DatabricksConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m DatabricksConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m DatabricksConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m DatabricksConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m DatabricksConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m DatabricksConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m DatabricksConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DatabricksConnectionSummary) String() string
func (m DatabricksConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatabricksConnectionTechnologyTypeEnum Enum with underlying type: string
type DatabricksConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for DatabricksConnectionTechnologyTypeEnum
const (
DatabricksConnectionTechnologyTypeDatabricks DatabricksConnectionTechnologyTypeEnum = "DATABRICKS"
)
func GetDatabricksConnectionTechnologyTypeEnumValues() []DatabricksConnectionTechnologyTypeEnum
GetDatabricksConnectionTechnologyTypeEnumValues Enumerates the set of values for DatabricksConnectionTechnologyTypeEnum
func GetMappingDatabricksConnectionTechnologyTypeEnum(val string) (DatabricksConnectionTechnologyTypeEnum, bool)
GetMappingDatabricksConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DayEnum Enum with underlying type: string
type DayEnum string
Set of constants representing the allowable values for DayEnum
const (
DayMonday DayEnum = "MONDAY"
DayTuesday DayEnum = "TUESDAY"
DayWednesday DayEnum = "WEDNESDAY"
DayThursday DayEnum = "THURSDAY"
DayFriday DayEnum = "FRIDAY"
DaySaturday DayEnum = "SATURDAY"
DaySunday DayEnum = "SUNDAY"
)
func GetDayEnumValues() []DayEnum
GetDayEnumValues Enumerates the set of values for DayEnum
func GetMappingDayEnum(val string) (DayEnum, bool)
GetMappingDayEnum performs case Insensitive comparison on enum value and return the desired enum
Db2Connection Represents the metadata of a DB2 Connection.
type Db2Connection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The username Oracle GoldenGate uses to connect to the DB2 database.
// This username must already exist and be available by the DB2 to be connected to.
Username *string `mandatory:"true" json:"username"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated DB2 database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored,
// which created at the client containing the server certificate / CA root certificate.
// Note: When provided, 'sslClientKeystoredb' field must not be provided.
SslClientKeystoredbSecretId *string `mandatory:"false" json:"sslClientKeystoredbSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored,
// which contains the encrypted password to the key database file.
// Note: When provided, 'sslClientKeystash' field must not be provided.
SslClientKeystashSecretId *string `mandatory:"false" json:"sslClientKeystashSecretId"`
// The DB2 technology type.
TechnologyType Db2ConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Protocol for the DB2 database.
SecurityProtocol Db2ConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m Db2Connection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m Db2Connection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m Db2Connection) GetDescription() *string
GetDescription returns Description
func (m Db2Connection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m Db2Connection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m Db2Connection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m Db2Connection) GetId() *string
GetId returns Id
func (m Db2Connection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m Db2Connection) GetKeyId() *string
GetKeyId returns KeyId
func (m Db2Connection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m Db2Connection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m Db2Connection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m Db2Connection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m Db2Connection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m Db2Connection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m Db2Connection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m Db2Connection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m Db2Connection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m Db2Connection) GetVaultId() *string
GetVaultId returns VaultId
func (m Db2Connection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m Db2Connection) String() string
func (m Db2Connection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Db2ConnectionSecurityProtocolEnum Enum with underlying type: string
type Db2ConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for Db2ConnectionSecurityProtocolEnum
const (
Db2ConnectionSecurityProtocolPlain Db2ConnectionSecurityProtocolEnum = "PLAIN"
Db2ConnectionSecurityProtocolTls Db2ConnectionSecurityProtocolEnum = "TLS"
)
func GetDb2ConnectionSecurityProtocolEnumValues() []Db2ConnectionSecurityProtocolEnum
GetDb2ConnectionSecurityProtocolEnumValues Enumerates the set of values for Db2ConnectionSecurityProtocolEnum
func GetMappingDb2ConnectionSecurityProtocolEnum(val string) (Db2ConnectionSecurityProtocolEnum, bool)
GetMappingDb2ConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
Db2ConnectionSummary Summary of the DB2 Connection.
type Db2ConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The username Oracle GoldenGate uses to connect to the DB2 database.
// This username must already exist and be available by the DB2 to be connected to.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated DB2 database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored,
// which created at the client containing the server certificate / CA root certificate.
// Note: When provided, 'sslClientKeystoredb' field must not be provided.
SslClientKeystoredbSecretId *string `mandatory:"false" json:"sslClientKeystoredbSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored,
// which contains the encrypted password to the key database file.
// Note: When provided, 'sslClientKeystash' field must not be provided.
SslClientKeystashSecretId *string `mandatory:"false" json:"sslClientKeystashSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The DB2 technology type.
TechnologyType Db2ConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for the DB2 database.
SecurityProtocol Db2ConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
}
func (m Db2ConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m Db2ConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m Db2ConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m Db2ConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m Db2ConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m Db2ConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m Db2ConnectionSummary) GetId() *string
GetId returns Id
func (m Db2ConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m Db2ConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m Db2ConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m Db2ConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m Db2ConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m Db2ConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m Db2ConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m Db2ConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m Db2ConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m Db2ConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m Db2ConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m Db2ConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m Db2ConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m Db2ConnectionSummary) String() string
func (m Db2ConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Db2ConnectionTechnologyTypeEnum Enum with underlying type: string
type Db2ConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for Db2ConnectionTechnologyTypeEnum
const (
Db2ConnectionTechnologyTypeDb2Zos Db2ConnectionTechnologyTypeEnum = "DB2_ZOS"
)
func GetDb2ConnectionTechnologyTypeEnumValues() []Db2ConnectionTechnologyTypeEnum
GetDb2ConnectionTechnologyTypeEnumValues Enumerates the set of values for Db2ConnectionTechnologyTypeEnum
func GetMappingDb2ConnectionTechnologyTypeEnum(val string) (Db2ConnectionTechnologyTypeEnum, bool)
GetMappingDb2ConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DefaultCancelDeploymentBackupDetails Definition of the additional attributes for default deployment backup cancel.
type DefaultCancelDeploymentBackupDetails struct {
}
func (m DefaultCancelDeploymentBackupDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultCancelDeploymentBackupDetails) String() string
func (m DefaultCancelDeploymentBackupDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultCancelDeploymentUpgradeDetails Definition of the additional attributes for default deployment upgrade cancel.
type DefaultCancelDeploymentUpgradeDetails struct {
}
func (m DefaultCancelDeploymentUpgradeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultCancelDeploymentUpgradeDetails) String() string
func (m DefaultCancelDeploymentUpgradeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultCancelSnoozeDeploymentUpgradeDetails Definition of the additional attributes for default deployment upgrade cancel snooze.
type DefaultCancelSnoozeDeploymentUpgradeDetails struct {
}
func (m DefaultCancelSnoozeDeploymentUpgradeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultCancelSnoozeDeploymentUpgradeDetails) String() string
func (m DefaultCancelSnoozeDeploymentUpgradeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultDeploymentWalletExistsDetails Definition of the additional attributes for default check of a wallet in deployment .
type DefaultDeploymentWalletExistsDetails struct {
}
func (m DefaultDeploymentWalletExistsDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultDeploymentWalletExistsDetails) String() string
func (m DefaultDeploymentWalletExistsDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultRefreshConnectionDetails Definition of the additional attributes for default Connection external attributes.
type DefaultRefreshConnectionDetails struct {
}
func (m DefaultRefreshConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultRefreshConnectionDetails) String() string
func (m DefaultRefreshConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultRestoreDeploymentDetails Definition of the additional attributes for default deployment restore.
type DefaultRestoreDeploymentDetails struct {
}
func (m DefaultRestoreDeploymentDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultRestoreDeploymentDetails) String() string
func (m DefaultRestoreDeploymentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultRollbackDeploymentUpgradeDetails Definition of the additional attributes for default upgrade rollback.
type DefaultRollbackDeploymentUpgradeDetails struct {
}
func (m DefaultRollbackDeploymentUpgradeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultRollbackDeploymentUpgradeDetails) String() string
func (m DefaultRollbackDeploymentUpgradeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultSnoozeDeploymentUpgradeDetails Definition of the additional attributes for default deployment upgrade snooze.
type DefaultSnoozeDeploymentUpgradeDetails struct {
}
func (m DefaultSnoozeDeploymentUpgradeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultSnoozeDeploymentUpgradeDetails) String() string
func (m DefaultSnoozeDeploymentUpgradeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultStartDeploymentDetails Definition of the additional attributes for default deployment start.
type DefaultStartDeploymentDetails struct {
}
func (m DefaultStartDeploymentDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultStartDeploymentDetails) String() string
func (m DefaultStartDeploymentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultStartPipelineDetails Attribute details for a default pipeline start.
type DefaultStartPipelineDetails struct {
}
func (m DefaultStartPipelineDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultStartPipelineDetails) String() string
func (m DefaultStartPipelineDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultStopDeploymentDetails Definition of the additional attributes for default deployment stop.
type DefaultStopDeploymentDetails struct {
}
func (m DefaultStopDeploymentDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultStopDeploymentDetails) String() string
func (m DefaultStopDeploymentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultStopPipelineDetails Attribute details for a default pipeline stop.
type DefaultStopPipelineDetails struct {
}
func (m DefaultStopPipelineDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultStopPipelineDetails) String() string
func (m DefaultStopPipelineDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultTestConnectionAssignmentDetails Definition of the additional attributes for default test of assigned connection.
type DefaultTestConnectionAssignmentDetails struct {
}
func (m DefaultTestConnectionAssignmentDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultTestConnectionAssignmentDetails) String() string
func (m DefaultTestConnectionAssignmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultTestPipelineConnectionDetails Additional attribute with which to test the pipeline's connection. The connectionId must be one of the pipeline's assigned connections.
type DefaultTestPipelineConnectionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
ConnectionId *string `mandatory:"true" json:"connectionId"`
}
func (m DefaultTestPipelineConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultTestPipelineConnectionDetails) String() string
func (m DefaultTestPipelineConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultUpgradeDeploymentUpgradeDetails Definition of the additional attributes for default deployment upgrade.
type DefaultUpgradeDeploymentUpgradeDetails struct {
}
func (m DefaultUpgradeDeploymentUpgradeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultUpgradeDeploymentUpgradeDetails) String() string
func (m DefaultUpgradeDeploymentUpgradeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCertificateRequest wrapper for the DeleteCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteCertificate.go.html to see an example of how to use DeleteCertificateRequest.
type DeleteCertificateRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A unique certificate identifier.
CertificateKey *string `mandatory:"true" contributesTo:"path" name:"certificateKey"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCertificateRequest) String() string
func (request DeleteCertificateRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCertificateResponse wrapper for the DeleteCertificate operation
type DeleteCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCertificateResponse) String() string
DeleteConnectionAssignmentRequest wrapper for the DeleteConnectionAssignment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteConnectionAssignment.go.html to see an example of how to use DeleteConnectionAssignmentRequest.
type DeleteConnectionAssignmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Connection Assignment.
ConnectionAssignmentId *string `mandatory:"true" contributesTo:"path" name:"connectionAssignmentId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteConnectionAssignmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteConnectionAssignmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteConnectionAssignmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteConnectionAssignmentRequest) String() string
func (request DeleteConnectionAssignmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteConnectionAssignmentResponse wrapper for the DeleteConnectionAssignment operation
type DeleteConnectionAssignmentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteConnectionAssignmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConnectionAssignmentResponse) String() string
DeleteConnectionRequest wrapper for the DeleteConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteConnection.go.html to see an example of how to use DeleteConnectionRequest.
type DeleteConnectionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Connection.
ConnectionId *string `mandatory:"true" contributesTo:"path" name:"connectionId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteConnectionRequest) String() string
func (request DeleteConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteConnectionResponse wrapper for the DeleteConnection operation
type DeleteConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConnectionResponse) String() string
DeleteDatabaseRegistrationRequest wrapper for the DeleteDatabaseRegistration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteDatabaseRegistration.go.html to see an example of how to use DeleteDatabaseRegistrationRequest.
type DeleteDatabaseRegistrationRequest struct {
// A unique DatabaseRegistration identifier.
DatabaseRegistrationId *string `mandatory:"true" contributesTo:"path" name:"databaseRegistrationId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDatabaseRegistrationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDatabaseRegistrationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDatabaseRegistrationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDatabaseRegistrationRequest) String() string
func (request DeleteDatabaseRegistrationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDatabaseRegistrationResponse wrapper for the DeleteDatabaseRegistration operation
type DeleteDatabaseRegistrationResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Deprecation date of this API version.
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response DeleteDatabaseRegistrationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDatabaseRegistrationResponse) String() string
DeleteDeploymentBackupRequest wrapper for the DeleteDeploymentBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteDeploymentBackup.go.html to see an example of how to use DeleteDeploymentBackupRequest.
type DeleteDeploymentBackupRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDeploymentBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDeploymentBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDeploymentBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDeploymentBackupRequest) String() string
func (request DeleteDeploymentBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDeploymentBackupResponse wrapper for the DeleteDeploymentBackup operation
type DeleteDeploymentBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDeploymentBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDeploymentBackupResponse) String() string
DeleteDeploymentRequest wrapper for the DeleteDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteDeployment.go.html to see an example of how to use DeleteDeploymentRequest.
type DeleteDeploymentRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDeploymentRequest) String() string
func (request DeleteDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDeploymentResponse wrapper for the DeleteDeployment operation
type DeleteDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDeploymentResponse) String() string
DeletePipelineRequest wrapper for the DeletePipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeletePipeline.go.html to see an example of how to use DeletePipelineRequest.
type DeletePipelineRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeletePipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePipelineRequest) String() string
func (request DeletePipelineRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeletePipelineResponse wrapper for the DeletePipeline operation
type DeletePipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeletePipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePipelineResponse) String() string
Deployment A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.
type Deployment struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the deployment's private endpoint.
// The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,
// after which the private subnet will be enforced.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"true" json:"licenseModel"`
// The deployment category defines the broad separation of the deployment type into three categories.
// Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
Category DeploymentCategoryEnum `mandatory:"true" json:"category"`
// The Minimum number of OCPUs to be made available for this Deployment.
CpuCoreCount *int `mandatory:"true" json:"cpuCoreCount"`
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
// The type of deployment, which can be any one of the Allowed values.
// NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes.
// Its use is discouraged in favor of 'DATABASE_ORACLE'.
DeploymentType DeploymentTypeEnum `mandatory:"true" json:"deploymentType"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.
DeploymentBackupId *string `mandatory:"false" json:"deploymentBackupId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Possible GGS lifecycle sub-states.
LifecycleSubState LifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// True if all of the aggregate resources are working correctly.
IsHealthy *bool `mandatory:"false" json:"isHealthy"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy.
// Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy.
// For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
LoadBalancerSubnetId *string `mandatory:"false" json:"loadBalancerSubnetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer's subnet.
// The loadbalancer of the public deployment created in the customer subnet.
LoadBalancerId *string `mandatory:"false" json:"loadBalancerId"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"false" json:"fqdn"`
// Specifies whether the deployment is used in a production or development/testing environment.
EnvironmentType EnvironmentTypeEnum `mandatory:"false" json:"environmentType,omitempty"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// True if this object is publicly available.
IsPublic *bool `mandatory:"false" json:"isPublic"`
// The public IP address representing the access point for the Deployment.
PublicIpAddress *string `mandatory:"false" json:"publicIpAddress"`
// The private IP address in the customer's VCN representing the access point for the
// associated endpoint service in the GoldenGate service VCN.
PrivateIpAddress *string `mandatory:"false" json:"privateIpAddress"`
// The URL of a resource.
DeploymentUrl *string `mandatory:"false" json:"deploymentUrl"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Indicates if the resource is the the latest available version.
IsLatestVersion *bool `mandatory:"false" json:"isLatestVersion"`
// Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records
// to check, when deployment will be forced to upgrade to a newer version.
// Old description:
// The date the existing version in use will no longer be considered as usable
// and an upgrade will be required. This date is typically 6 months after the
// version was released for use by GGS. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpgradeRequired *common.SDKTime `mandatory:"false" json:"timeUpgradeRequired"`
// The amount of storage being utilized (in bytes)
StorageUtilizationInBytes *int64 `mandatory:"false" json:"storageUtilizationInBytes"`
// Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=.
// Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment's GoldenGate service.
IsStorageUtilizationLimitExceeded *bool `mandatory:"false" json:"isStorageUtilizationLimitExceeded"`
OggData *OggDeployment `mandatory:"false" json:"oggData"`
DeploymentDiagnosticData *DeploymentDiagnosticData `mandatory:"false" json:"deploymentDiagnosticData"`
MaintenanceWindow *MaintenanceWindow `mandatory:"false" json:"maintenanceWindow"`
// The time of next maintenance schedule. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeOfNextMaintenance *common.SDKTime `mandatory:"false" json:"timeOfNextMaintenance"`
// Type of the next maintenance.
NextMaintenanceActionType MaintenanceActionTypeEnum `mandatory:"false" json:"nextMaintenanceActionType,omitempty"`
// Description of the next maintenance.
NextMaintenanceDescription *string `mandatory:"false" json:"nextMaintenanceDescription"`
MaintenanceConfiguration *MaintenanceConfiguration `mandatory:"false" json:"maintenanceConfiguration"`
// The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeOggVersionSupportedUntil *common.SDKTime `mandatory:"false" json:"timeOggVersionSupportedUntil"`
BackupSchedule *BackupSchedule `mandatory:"false" json:"backupSchedule"`
// The timestamp of last deployment backup scheduled. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.
TimeLastBackupScheduled *common.SDKTime `mandatory:"false" json:"timeLastBackupScheduled"`
// The timestamp of next deployment backup scheduled. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.
TimeNextBackupScheduled *common.SDKTime `mandatory:"false" json:"timeNextBackupScheduled"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
}
func (m Deployment) String() string
func (m Deployment) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentBackup A backup of the current state of the GoldenGate deployment. Can be used to restore a deployment, or create a new deployment with that state as the starting deployment state.
type DeploymentBackup struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// The type of deployment, which can be any one of the Allowed values.
// NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes.
// Its use is discouraged in favor of 'DATABASE_ORACLE'.
DeploymentType DeploymentTypeEnum `mandatory:"true" json:"deploymentType"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Version of OGG
OggVersion *string `mandatory:"true" json:"oggVersion"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// True if this object is automatically created
IsAutomatic *bool `mandatory:"false" json:"isAutomatic"`
// Possible deployment backup source types.
BackupSourceType DeploymentBackupBackupSourceTypeEnum `mandatory:"false" json:"backupSourceType,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time of the resource backup. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeOfBackup *common.SDKTime `mandatory:"false" json:"timeOfBackup"`
// The time of the resource backup finish. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeBackupFinished *common.SDKTime `mandatory:"false" json:"timeBackupFinished"`
// The size of the backup stored in object storage (in bytes)
SizeInBytes *int64 `mandatory:"false" json:"sizeInBytes"`
// Possible Deployment backup types.
BackupType DeploymentBackupTypeEnum `mandatory:"false" json:"backupType,omitempty"`
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"false" json:"namespaceName"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"false" json:"bucketName"`
// Name of the object to be uploaded to object storage
ObjectName *string `mandatory:"false" json:"objectName"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Parameter to allow users to create backup without trails
IsMetadataOnly *bool `mandatory:"false" json:"isMetadataOnly"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m DeploymentBackup) String() string
func (m DeploymentBackup) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentBackupBackupSourceTypeEnum Enum with underlying type: string
type DeploymentBackupBackupSourceTypeEnum string
Set of constants representing the allowable values for DeploymentBackupBackupSourceTypeEnum
const (
DeploymentBackupBackupSourceTypeManual DeploymentBackupBackupSourceTypeEnum = "MANUAL"
DeploymentBackupBackupSourceTypeAutomatic DeploymentBackupBackupSourceTypeEnum = "AUTOMATIC"
DeploymentBackupBackupSourceTypeScheduled DeploymentBackupBackupSourceTypeEnum = "SCHEDULED"
)
func GetDeploymentBackupBackupSourceTypeEnumValues() []DeploymentBackupBackupSourceTypeEnum
GetDeploymentBackupBackupSourceTypeEnumValues Enumerates the set of values for DeploymentBackupBackupSourceTypeEnum
func GetMappingDeploymentBackupBackupSourceTypeEnum(val string) (DeploymentBackupBackupSourceTypeEnum, bool)
GetMappingDeploymentBackupBackupSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentBackupCollection A list of DeploymentBackups.
type DeploymentBackupCollection struct {
// An array of DeploymentBackups.
Items []DeploymentBackupSummary `mandatory:"true" json:"items"`
}
func (m DeploymentBackupCollection) String() string
func (m DeploymentBackupCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentBackupSummary The summary of the Backup.
type DeploymentBackupSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// The type of deployment, which can be any one of the Allowed values.
// NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes.
// Its use is discouraged in favor of 'DATABASE_ORACLE'.
DeploymentType DeploymentTypeEnum `mandatory:"true" json:"deploymentType"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Version of OGG
OggVersion *string `mandatory:"true" json:"oggVersion"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// True if this object is automatically created
IsAutomatic *bool `mandatory:"false" json:"isAutomatic"`
// Possible deployment backup source types.
BackupSourceType DeploymentBackupSummaryBackupSourceTypeEnum `mandatory:"false" json:"backupSourceType,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time of the resource backup. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeOfBackup *common.SDKTime `mandatory:"false" json:"timeOfBackup"`
// The time of the resource backup finish. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeBackupFinished *common.SDKTime `mandatory:"false" json:"timeBackupFinished"`
// The size of the backup stored in object storage (in bytes)
SizeInBytes *int64 `mandatory:"false" json:"sizeInBytes"`
// Possible Deployment backup types.
BackupType DeploymentBackupTypeEnum `mandatory:"false" json:"backupType,omitempty"`
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"false" json:"namespaceName"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"false" json:"bucketName"`
// Name of the object to be uploaded to object storage
ObjectName *string `mandatory:"false" json:"objectName"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Parameter to allow users to create backup without trails
IsMetadataOnly *bool `mandatory:"false" json:"isMetadataOnly"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m DeploymentBackupSummary) String() string
func (m DeploymentBackupSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentBackupSummaryBackupSourceTypeEnum Enum with underlying type: string
type DeploymentBackupSummaryBackupSourceTypeEnum string
Set of constants representing the allowable values for DeploymentBackupSummaryBackupSourceTypeEnum
const (
DeploymentBackupSummaryBackupSourceTypeManual DeploymentBackupSummaryBackupSourceTypeEnum = "MANUAL"
DeploymentBackupSummaryBackupSourceTypeAutomatic DeploymentBackupSummaryBackupSourceTypeEnum = "AUTOMATIC"
DeploymentBackupSummaryBackupSourceTypeScheduled DeploymentBackupSummaryBackupSourceTypeEnum = "SCHEDULED"
)
func GetDeploymentBackupSummaryBackupSourceTypeEnumValues() []DeploymentBackupSummaryBackupSourceTypeEnum
GetDeploymentBackupSummaryBackupSourceTypeEnumValues Enumerates the set of values for DeploymentBackupSummaryBackupSourceTypeEnum
func GetMappingDeploymentBackupSummaryBackupSourceTypeEnum(val string) (DeploymentBackupSummaryBackupSourceTypeEnum, bool)
GetMappingDeploymentBackupSummaryBackupSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentBackupTypeEnum Enum with underlying type: string
type DeploymentBackupTypeEnum string
Set of constants representing the allowable values for DeploymentBackupTypeEnum
const (
DeploymentBackupTypeIncremental DeploymentBackupTypeEnum = "INCREMENTAL"
DeploymentBackupTypeFull DeploymentBackupTypeEnum = "FULL"
)
func GetDeploymentBackupTypeEnumValues() []DeploymentBackupTypeEnum
GetDeploymentBackupTypeEnumValues Enumerates the set of values for DeploymentBackupTypeEnum
func GetMappingDeploymentBackupTypeEnum(val string) (DeploymentBackupTypeEnum, bool)
GetMappingDeploymentBackupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentCategoryEnum Enum with underlying type: string
type DeploymentCategoryEnum string
Set of constants representing the allowable values for DeploymentCategoryEnum
const (
DeploymentCategoryDataReplication DeploymentCategoryEnum = "DATA_REPLICATION"
DeploymentCategoryStreamAnalytics DeploymentCategoryEnum = "STREAM_ANALYTICS"
DeploymentCategoryDataTransforms DeploymentCategoryEnum = "DATA_TRANSFORMS"
)
func GetDeploymentCategoryEnumValues() []DeploymentCategoryEnum
GetDeploymentCategoryEnumValues Enumerates the set of values for DeploymentCategoryEnum
func GetMappingDeploymentCategoryEnum(val string) (DeploymentCategoryEnum, bool)
GetMappingDeploymentCategoryEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentCollection A list of Deployments.
type DeploymentCollection struct {
// An array of Deployment summaries.
Items []DeploymentSummary `mandatory:"true" json:"items"`
}
func (m DeploymentCollection) String() string
func (m DeploymentCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentDiagnosticData Information regarding the deployment diagnostic collection
type DeploymentDiagnosticData struct {
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"true" json:"bucketName"`
// Name of the diagnostic collected and uploaded to object storage
ObjectName *string `mandatory:"true" json:"objectName"`
// The state of the deployment diagnostic collection.
DiagnosticState DeploymentDiagnosticStateEnum `mandatory:"true" json:"diagnosticState"`
// The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeDiagnosticStart *common.SDKTime `mandatory:"false" json:"timeDiagnosticStart"`
// The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeDiagnosticEnd *common.SDKTime `mandatory:"false" json:"timeDiagnosticEnd"`
}
func (m DeploymentDiagnosticData) String() string
func (m DeploymentDiagnosticData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentDiagnosticStateEnum Enum with underlying type: string
type DeploymentDiagnosticStateEnum string
Set of constants representing the allowable values for DeploymentDiagnosticStateEnum
const (
DeploymentDiagnosticStateInProgress DeploymentDiagnosticStateEnum = "IN_PROGRESS"
DeploymentDiagnosticStateSucceeded DeploymentDiagnosticStateEnum = "SUCCEEDED"
DeploymentDiagnosticStateFailed DeploymentDiagnosticStateEnum = "FAILED"
)
func GetDeploymentDiagnosticStateEnumValues() []DeploymentDiagnosticStateEnum
GetDeploymentDiagnosticStateEnumValues Enumerates the set of values for DeploymentDiagnosticStateEnum
func GetMappingDeploymentDiagnosticStateEnum(val string) (DeploymentDiagnosticStateEnum, bool)
GetMappingDeploymentDiagnosticStateEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentEnvironmentCollection The list of DeploymentEnvironmentDescriptor objects.
type DeploymentEnvironmentCollection struct {
// Array of DeploymentEnvironmentSummary objects.
Items []DeploymentEnvironmentSummary `mandatory:"true" json:"items"`
}
func (m DeploymentEnvironmentCollection) String() string
func (m DeploymentEnvironmentCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentEnvironmentSummary The metadata specific to a production or development/testing environment.
type DeploymentEnvironmentSummary struct {
// Specifies whether the deployment is used in a production or development/testing environment.
EnvironmentType EnvironmentTypeEnum `mandatory:"true" json:"environmentType"`
// The deployment category defines the broad separation of the deployment type into three categories.
// Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
Category DeploymentCategoryEnum `mandatory:"true" json:"category"`
// The minimum CPU core count.
MinCpuCoreCount *int `mandatory:"true" json:"minCpuCoreCount"`
// The default CPU core count.
DefaultCpuCoreCount *int `mandatory:"true" json:"defaultCpuCoreCount"`
// The maximum CPU core count.
MaxCpuCoreCount *int `mandatory:"true" json:"maxCpuCoreCount"`
// Specifies whether the "Auto scaling" option should be enabled by default or not.
IsAutoScalingEnabledByDefault *bool `mandatory:"true" json:"isAutoScalingEnabledByDefault"`
// The multiplier value between CPU core count and network bandwidth.
NetworkBandwidthPerOcpuInGbps *int `mandatory:"true" json:"networkBandwidthPerOcpuInGbps"`
// The multiplier value between CPU core count and memory size.
MemoryPerOcpuInGBs *int `mandatory:"true" json:"memoryPerOcpuInGBs"`
// The multiplier value between CPU core count and storage usage limit size.
StorageUsageLimitPerOcpuInGBs *int `mandatory:"true" json:"storageUsageLimitPerOcpuInGBs"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m DeploymentEnvironmentSummary) String() string
func (m DeploymentEnvironmentSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentMessageCollection A list of DeploymentMessages.
type DeploymentMessageCollection struct {
// An array of DeploymentMessages.
Items []MessageSummary `mandatory:"true" json:"items"`
}
func (m DeploymentMessageCollection) String() string
func (m DeploymentMessageCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentSummary Summary of the Deployment.
type DeploymentSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the deployment's private endpoint.
// The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,
// after which the private subnet will be enforced.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"true" json:"licenseModel"`
// The deployment category defines the broad separation of the deployment type into three categories.
// Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
Category DeploymentCategoryEnum `mandatory:"true" json:"category"`
// The type of deployment, which can be any one of the Allowed values.
// NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes.
// Its use is discouraged in favor of 'DATABASE_ORACLE'.
DeploymentType DeploymentTypeEnum `mandatory:"true" json:"deploymentType"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Possible GGS lifecycle sub-states.
LifecycleSubState LifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy.
// Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy.
// For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
LoadBalancerSubnetId *string `mandatory:"false" json:"loadBalancerSubnetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer's subnet.
// The loadbalancer of the public deployment created in the customer subnet.
LoadBalancerId *string `mandatory:"false" json:"loadBalancerId"`
// Specifies whether the deployment is used in a production or development/testing environment.
EnvironmentType EnvironmentTypeEnum `mandatory:"false" json:"environmentType,omitempty"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"false" json:"fqdn"`
// The Minimum number of OCPUs to be made available for this Deployment.
CpuCoreCount *int `mandatory:"false" json:"cpuCoreCount"`
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsAutoScalingEnabled *bool `mandatory:"false" json:"isAutoScalingEnabled"`
// True if this object is publicly available.
IsPublic *bool `mandatory:"false" json:"isPublic"`
// The public IP address representing the access point for the Deployment.
PublicIpAddress *string `mandatory:"false" json:"publicIpAddress"`
// The private IP address in the customer's VCN representing the access point for the
// associated endpoint service in the GoldenGate service VCN.
PrivateIpAddress *string `mandatory:"false" json:"privateIpAddress"`
// The URL of a resource.
DeploymentUrl *string `mandatory:"false" json:"deploymentUrl"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Indicates if the resource is the the latest available version.
IsLatestVersion *bool `mandatory:"false" json:"isLatestVersion"`
// Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records
// to check, when deployment will be forced to upgrade to a newer version.
// Old description:
// The date the existing version in use will no longer be considered as usable
// and an upgrade will be required. This date is typically 6 months after the
// version was released for use by GGS. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpgradeRequired *common.SDKTime `mandatory:"false" json:"timeUpgradeRequired"`
// The amount of storage being utilized (in bytes)
StorageUtilizationInBytes *int64 `mandatory:"false" json:"storageUtilizationInBytes"`
// Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=.
// Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment's GoldenGate service.
IsStorageUtilizationLimitExceeded *bool `mandatory:"false" json:"isStorageUtilizationLimitExceeded"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m DeploymentSummary) String() string
func (m DeploymentSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentTypeCollection The list of DeploymentTypeDescriptor objects.
type DeploymentTypeCollection struct {
// Array of DeploymentTypeSummary
Items []DeploymentTypeSummary `mandatory:"true" json:"items"`
}
func (m DeploymentTypeCollection) String() string
func (m DeploymentTypeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentTypeEnum Enum with underlying type: string
type DeploymentTypeEnum string
Set of constants representing the allowable values for DeploymentTypeEnum
const (
DeploymentTypeOgg DeploymentTypeEnum = "OGG"
DeploymentTypeDatabaseOracle DeploymentTypeEnum = "DATABASE_ORACLE"
DeploymentTypeBigdata DeploymentTypeEnum = "BIGDATA"
DeploymentTypeDatabaseMicrosoftSqlserver DeploymentTypeEnum = "DATABASE_MICROSOFT_SQLSERVER"
DeploymentTypeDatabaseMysql DeploymentTypeEnum = "DATABASE_MYSQL"
DeploymentTypeDatabasePostgresql DeploymentTypeEnum = "DATABASE_POSTGRESQL"
DeploymentTypeDatabaseDb2Zos DeploymentTypeEnum = "DATABASE_DB2ZOS"
DeploymentTypeGgsa DeploymentTypeEnum = "GGSA"
DeploymentTypeDataTransforms DeploymentTypeEnum = "DATA_TRANSFORMS"
)
func GetDeploymentTypeEnumValues() []DeploymentTypeEnum
GetDeploymentTypeEnumValues Enumerates the set of values for DeploymentTypeEnum
func GetMappingDeploymentTypeEnum(val string) (DeploymentTypeEnum, bool)
GetMappingDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentTypeSummary The meta-data specific on particular deployment type represented by deploymentType field. Deprecated properties: `sourceTechnologies` and `targetTechnologies` are not populated. They will be removed after September 15 2025. The list of supported source and target technologies can be accessed using the url provided in `supportedTechnologiesUrl` property.
type DeploymentTypeSummary struct {
// The deployment category defines the broad separation of the deployment type into three categories.
// Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
Category DeploymentCategoryEnum `mandatory:"true" json:"category"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The type of deployment, which can be any one of the Allowed values.
// NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes.
// Its use is discouraged in favor of 'DATABASE_ORACLE'.
DeploymentType DeploymentTypeEnum `mandatory:"true" json:"deploymentType"`
// An array of connectionTypes.
ConnectionTypes []ConnectionTypeEnum `mandatory:"false" json:"connectionTypes,omitempty"`
// List of the supported technologies generally. The value is a freeform text string generally consisting
// of a description of the technology and optionally the speific version(s) support. For example,
// [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ]
SourceTechnologies []string `mandatory:"false" json:"sourceTechnologies"`
// List of the supported technologies generally. The value is a freeform text string generally consisting
// of a description of the technology and optionally the speific version(s) support. For example,
// [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ]
TargetTechnologies []string `mandatory:"false" json:"targetTechnologies"`
// Version of OGG
OggVersion *string `mandatory:"false" json:"oggVersion"`
// The URL to the webpage listing the supported technologies.
SupportedTechnologiesUrl *string `mandatory:"false" json:"supportedTechnologiesUrl"`
// The default admin username used by deployment.
DefaultUsername *string `mandatory:"false" json:"defaultUsername"`
}
func (m DeploymentTypeSummary) String() string
func (m DeploymentTypeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentUpgrade A container for your OCI GoldenGate Upgrade information.
type DeploymentUpgrade struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment upgrade being referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// The type of the deployment upgrade: MANUAL or AUTOMATIC
DeploymentUpgradeType DeploymentUpgradeTypeEnum `mandatory:"true" json:"deploymentUpgradeType"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// The date and time the request was started. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// Version of OGG
OggVersion *string `mandatory:"false" json:"oggVersion"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Possible GGS lifecycle sub-states.
LifecycleSubState LifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Version of OGG
PreviousOggVersion *string `mandatory:"false" json:"previousOggVersion"`
// The time of upgrade schedule. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeSchedule *common.SDKTime `mandatory:"false" json:"timeSchedule"`
// Indicates if upgrade notifications are snoozed or not.
IsSnoozed *bool `mandatory:"false" json:"isSnoozed"`
// The time the upgrade notifications are snoozed until. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeSnoozedUntil *common.SDKTime `mandatory:"false" json:"timeSnoozedUntil"`
// The time the resource was released. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeReleased *common.SDKTime `mandatory:"false" json:"timeReleased"`
// The type of release.
ReleaseType ReleaseTypeEnum `mandatory:"false" json:"releaseType,omitempty"`
// Indicates if OGG release contains security fix.
IsSecurityFix *bool `mandatory:"false" json:"isSecurityFix"`
// Indicates if rollback is allowed. In practice only the last upgrade can be rolled back.
// - Manual upgrade is allowed to rollback only until the old version isn't deprecated yet.
// - Automatic upgrade by default is not allowed, unless a serious issue does not justify.
IsRollbackAllowed *bool `mandatory:"false" json:"isRollbackAllowed"`
// The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeOggVersionSupportedUntil *common.SDKTime `mandatory:"false" json:"timeOggVersionSupportedUntil"`
// Indicates if cancel is allowed. Scheduled upgrade can be cancelled only if target version is not forced by service,
// otherwise only reschedule allowed.
IsCancelAllowed *bool `mandatory:"false" json:"isCancelAllowed"`
// Indicates if reschedule is allowed. Upgrade can be rescheduled postponed until the end of the service defined auto-upgrade period.
IsRescheduleAllowed *bool `mandatory:"false" json:"isRescheduleAllowed"`
// Indicates the latest time until the deployment upgrade could be rescheduled. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeScheduleMax *common.SDKTime `mandatory:"false" json:"timeScheduleMax"`
}
func (m DeploymentUpgrade) String() string
func (m DeploymentUpgrade) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentUpgradeCollection A list of Deployment Upgrades.
type DeploymentUpgradeCollection struct {
// An array of Deployment Upgrade summaries.
Items []DeploymentUpgradeSummary `mandatory:"true" json:"items"`
}
func (m DeploymentUpgradeCollection) String() string
func (m DeploymentUpgradeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentUpgradeLifecycleStateEnum Enum with underlying type: string
type DeploymentUpgradeLifecycleStateEnum string
Set of constants representing the allowable values for DeploymentUpgradeLifecycleStateEnum
const (
DeploymentUpgradeLifecycleStateWaiting DeploymentUpgradeLifecycleStateEnum = "WAITING"
DeploymentUpgradeLifecycleStateInProgress DeploymentUpgradeLifecycleStateEnum = "IN_PROGRESS"
DeploymentUpgradeLifecycleStateFailed DeploymentUpgradeLifecycleStateEnum = "FAILED"
DeploymentUpgradeLifecycleStateSucceeded DeploymentUpgradeLifecycleStateEnum = "SUCCEEDED"
DeploymentUpgradeLifecycleStateCanceling DeploymentUpgradeLifecycleStateEnum = "CANCELING"
DeploymentUpgradeLifecycleStateCanceled DeploymentUpgradeLifecycleStateEnum = "CANCELED"
DeploymentUpgradeLifecycleStateNeedsAttention DeploymentUpgradeLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetDeploymentUpgradeLifecycleStateEnumValues() []DeploymentUpgradeLifecycleStateEnum
GetDeploymentUpgradeLifecycleStateEnumValues Enumerates the set of values for DeploymentUpgradeLifecycleStateEnum
func GetMappingDeploymentUpgradeLifecycleStateEnum(val string) (DeploymentUpgradeLifecycleStateEnum, bool)
GetMappingDeploymentUpgradeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentUpgradeSummary Summary of the Deployment Upgrade.
type DeploymentUpgradeSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
// The type of the deployment upgrade: MANUAL or AUTOMATIC
DeploymentUpgradeType DeploymentUpgradeTypeEnum `mandatory:"true" json:"deploymentUpgradeType"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// The date and time the request was started. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// Version of OGG
OggVersion *string `mandatory:"false" json:"oggVersion"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Possible lifecycle states.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Possible GGS lifecycle sub-states.
LifecycleSubState LifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Version of OGG
PreviousOggVersion *string `mandatory:"false" json:"previousOggVersion"`
// The time of upgrade schedule. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeSchedule *common.SDKTime `mandatory:"false" json:"timeSchedule"`
// Indicates if upgrade notifications are snoozed or not.
IsSnoozed *bool `mandatory:"false" json:"isSnoozed"`
// The time the upgrade notifications are snoozed until. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeSnoozedUntil *common.SDKTime `mandatory:"false" json:"timeSnoozedUntil"`
// The time the resource was released. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeReleased *common.SDKTime `mandatory:"false" json:"timeReleased"`
// The type of release.
ReleaseType ReleaseTypeEnum `mandatory:"false" json:"releaseType,omitempty"`
// Indicates if OGG release contains security fix.
IsSecurityFix *bool `mandatory:"false" json:"isSecurityFix"`
// Indicates if rollback is allowed. In practice only the last upgrade can be rolled back.
// - Manual upgrade is allowed to rollback only until the old version isn't deprecated yet.
// - Automatic upgrade by default is not allowed, unless a serious issue does not justify.
IsRollbackAllowed *bool `mandatory:"false" json:"isRollbackAllowed"`
// The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeOggVersionSupportedUntil *common.SDKTime `mandatory:"false" json:"timeOggVersionSupportedUntil"`
// Indicates if cancel is allowed. Scheduled upgrade can be cancelled only if target version is not forced by service,
// otherwise only reschedule allowed.
IsCancelAllowed *bool `mandatory:"false" json:"isCancelAllowed"`
// Indicates if reschedule is allowed. Upgrade can be rescheduled postponed until the end of the service defined auto-upgrade period.
IsRescheduleAllowed *bool `mandatory:"false" json:"isRescheduleAllowed"`
// Indicates the latest time until the deployment upgrade could be rescheduled. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeScheduleMax *common.SDKTime `mandatory:"false" json:"timeScheduleMax"`
}
func (m DeploymentUpgradeSummary) String() string
func (m DeploymentUpgradeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentUpgradeTypeEnum Enum with underlying type: string
type DeploymentUpgradeTypeEnum string
Set of constants representing the allowable values for DeploymentUpgradeTypeEnum
const (
DeploymentUpgradeTypeManual DeploymentUpgradeTypeEnum = "MANUAL"
DeploymentUpgradeTypeAutomatic DeploymentUpgradeTypeEnum = "AUTOMATIC"
)
func GetDeploymentUpgradeTypeEnumValues() []DeploymentUpgradeTypeEnum
GetDeploymentUpgradeTypeEnumValues Enumerates the set of values for DeploymentUpgradeTypeEnum
func GetMappingDeploymentUpgradeTypeEnum(val string) (DeploymentUpgradeTypeEnum, bool)
GetMappingDeploymentUpgradeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentVersionCollection The list of DeploymentVersionSummary objects.
type DeploymentVersionCollection struct {
// Array of DeploymentVersionSummary.
Items []DeploymentVersionSummary `mandatory:"true" json:"items"`
}
func (m DeploymentVersionCollection) String() string
func (m DeploymentVersionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentVersionSummary The summary data of a specific deployment version.
type DeploymentVersionSummary struct {
// Version of OGG
OggVersion *string `mandatory:"true" json:"oggVersion"`
// The type of deployment, which can be any one of the Allowed values.
// NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes.
// Its use is discouraged in favor of 'DATABASE_ORACLE'.
DeploymentType DeploymentTypeEnum `mandatory:"true" json:"deploymentType"`
// The time the resource was released. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeReleased *common.SDKTime `mandatory:"false" json:"timeReleased"`
// The type of release.
ReleaseType ReleaseTypeEnum `mandatory:"false" json:"releaseType,omitempty"`
// Indicates if OGG release contains security fix.
IsSecurityFix *bool `mandatory:"false" json:"isSecurityFix"`
// The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeSupportedUntil *common.SDKTime `mandatory:"false" json:"timeSupportedUntil"`
}
func (m DeploymentVersionSummary) String() string
func (m DeploymentVersionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentWalletExistsDetails The information to check if a wallet is present in the Deployment.
type DeploymentWalletExistsDetails interface {
}
DeploymentWalletExistsRequest wrapper for the DeploymentWalletExists operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeploymentWalletExists.go.html to see an example of how to use DeploymentWalletExistsRequest.
type DeploymentWalletExistsRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A placeholder for any additional metadata to describe the deployment start.
DeploymentWalletExistsDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeploymentWalletExistsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeploymentWalletExistsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeploymentWalletExistsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeploymentWalletExistsRequest) String() string
func (request DeploymentWalletExistsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentWalletExistsResponse wrapper for the DeploymentWalletExists operation
type DeploymentWalletExistsResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentWalletExistsResponseDetails instance
DeploymentWalletExistsResponseDetails `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response DeploymentWalletExistsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeploymentWalletExistsResponse) String() string
DeploymentWalletExistsResponseDetails Indicates whether the wallet exists in the deployment container
type DeploymentWalletExistsResponseDetails struct {
// Indicates if the wallet is present in the deployment container
IsOggWalletExists *bool `mandatory:"true" json:"isOggWalletExists"`
}
func (m DeploymentWalletExistsResponseDetails) String() string
func (m DeploymentWalletExistsResponseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentWalletOperationTypeEnum Enum with underlying type: string
type DeploymentWalletOperationTypeEnum string
Set of constants representing the allowable values for DeploymentWalletOperationTypeEnum
const (
DeploymentWalletOperationTypeExport DeploymentWalletOperationTypeEnum = "EXPORT"
DeploymentWalletOperationTypeImport DeploymentWalletOperationTypeEnum = "IMPORT"
)
func GetDeploymentWalletOperationTypeEnumValues() []DeploymentWalletOperationTypeEnum
GetDeploymentWalletOperationTypeEnumValues Enumerates the set of values for DeploymentWalletOperationTypeEnum
func GetMappingDeploymentWalletOperationTypeEnum(val string) (DeploymentWalletOperationTypeEnum, bool)
GetMappingDeploymentWalletOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentWalletStatusEnum Enum with underlying type: string
type DeploymentWalletStatusEnum string
Set of constants representing the allowable values for DeploymentWalletStatusEnum
const (
DeploymentWalletStatusExporting DeploymentWalletStatusEnum = "EXPORTING"
DeploymentWalletStatusExported DeploymentWalletStatusEnum = "EXPORTED"
DeploymentWalletStatusImported DeploymentWalletStatusEnum = "IMPORTED"
DeploymentWalletStatusImporting DeploymentWalletStatusEnum = "IMPORTING"
DeploymentWalletStatusFailed DeploymentWalletStatusEnum = "FAILED"
)
func GetDeploymentWalletStatusEnumValues() []DeploymentWalletStatusEnum
GetDeploymentWalletStatusEnumValues Enumerates the set of values for DeploymentWalletStatusEnum
func GetMappingDeploymentWalletStatusEnum(val string) (DeploymentWalletStatusEnum, bool)
GetMappingDeploymentWalletStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentWalletsOperationCollection A list of deployment wallets operations.
type DeploymentWalletsOperationCollection struct {
// An array of DeploymentWallets operations.
Items []DeploymentWalletsOperationSummary `mandatory:"true" json:"items"`
}
func (m DeploymentWalletsOperationCollection) String() string
func (m DeploymentWalletsOperationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeploymentWalletsOperationSummary Summary of the deployment wallets operations.
type DeploymentWalletsOperationSummary struct {
// The UUID of the wallet operation performed by the customer.
// If provided, this will reference a key which the customer can use to query or search a particular wallet operation
WalletOperationId *string `mandatory:"true" json:"walletOperationId"`
// The OCID of the customer's GoldenGate Service Secret.
// If provided, it references a key that customers will be required to ensure the policies are established
// to permit GoldenGate to use this Secret.
WalletSecretId *string `mandatory:"true" json:"walletSecretId"`
// The operation type of the deployment wallet.
DeploymentWalletOperationType DeploymentWalletOperationTypeEnum `mandatory:"true" json:"deploymentWalletOperationType"`
// The status of the deployment wallet.
DeploymentWalletOperationStatus DeploymentWalletStatusEnum `mandatory:"true" json:"deploymentWalletOperationStatus"`
// The date and time the request was started. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// The date and time the request was finished. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCompleted *common.SDKTime `mandatory:"false" json:"timeCompleted"`
}
func (m DeploymentWalletsOperationSummary) String() string
func (m DeploymentWalletsOperationSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ElasticsearchConnection Represents the metadata of a Elasticsearch Connection.
type ElasticsearchConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 9200.
// Used for establishing the initial connection to the Elasticsearch cluster.
// Example: `"server1.example.com:4000,server2.example.com:4000"`
Servers *string `mandatory:"true" json:"servers"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The Elasticsearch technology type.
TechnologyType ElasticsearchConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Elasticsearch
SecurityProtocol ElasticsearchConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Authentication type for Elasticsearch.
AuthenticationType ElasticsearchConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m ElasticsearchConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ElasticsearchConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ElasticsearchConnection) GetDescription() *string
GetDescription returns Description
func (m ElasticsearchConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m ElasticsearchConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m ElasticsearchConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ElasticsearchConnection) GetId() *string
GetId returns Id
func (m ElasticsearchConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m ElasticsearchConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m ElasticsearchConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m ElasticsearchConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ElasticsearchConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m ElasticsearchConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m ElasticsearchConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m ElasticsearchConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m ElasticsearchConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m ElasticsearchConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ElasticsearchConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ElasticsearchConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m ElasticsearchConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ElasticsearchConnection) String() string
func (m ElasticsearchConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ElasticsearchConnectionAuthenticationTypeEnum Enum with underlying type: string
type ElasticsearchConnectionAuthenticationTypeEnum string
Set of constants representing the allowable values for ElasticsearchConnectionAuthenticationTypeEnum
const (
ElasticsearchConnectionAuthenticationTypeNone ElasticsearchConnectionAuthenticationTypeEnum = "NONE"
ElasticsearchConnectionAuthenticationTypeBasic ElasticsearchConnectionAuthenticationTypeEnum = "BASIC"
)
func GetElasticsearchConnectionAuthenticationTypeEnumValues() []ElasticsearchConnectionAuthenticationTypeEnum
GetElasticsearchConnectionAuthenticationTypeEnumValues Enumerates the set of values for ElasticsearchConnectionAuthenticationTypeEnum
func GetMappingElasticsearchConnectionAuthenticationTypeEnum(val string) (ElasticsearchConnectionAuthenticationTypeEnum, bool)
GetMappingElasticsearchConnectionAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ElasticsearchConnectionSecurityProtocolEnum Enum with underlying type: string
type ElasticsearchConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for ElasticsearchConnectionSecurityProtocolEnum
const (
ElasticsearchConnectionSecurityProtocolPlain ElasticsearchConnectionSecurityProtocolEnum = "PLAIN"
ElasticsearchConnectionSecurityProtocolTls ElasticsearchConnectionSecurityProtocolEnum = "TLS"
)
func GetElasticsearchConnectionSecurityProtocolEnumValues() []ElasticsearchConnectionSecurityProtocolEnum
GetElasticsearchConnectionSecurityProtocolEnumValues Enumerates the set of values for ElasticsearchConnectionSecurityProtocolEnum
func GetMappingElasticsearchConnectionSecurityProtocolEnum(val string) (ElasticsearchConnectionSecurityProtocolEnum, bool)
GetMappingElasticsearchConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
ElasticsearchConnectionSummary Summary of the Elasticsearch Connection.
type ElasticsearchConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 9200.
// Used for establishing the initial connection to the Elasticsearch cluster.
// Example: `"server1.example.com:4000,server2.example.com:4000"`
Servers *string `mandatory:"true" json:"servers"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Elasticsearch technology type.
TechnologyType ElasticsearchConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Elasticsearch.
SecurityProtocol ElasticsearchConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Authentication type for Elasticsearch.
AuthenticationType ElasticsearchConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m ElasticsearchConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ElasticsearchConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ElasticsearchConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m ElasticsearchConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m ElasticsearchConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m ElasticsearchConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ElasticsearchConnectionSummary) GetId() *string
GetId returns Id
func (m ElasticsearchConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m ElasticsearchConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m ElasticsearchConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m ElasticsearchConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ElasticsearchConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m ElasticsearchConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m ElasticsearchConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m ElasticsearchConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m ElasticsearchConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m ElasticsearchConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ElasticsearchConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ElasticsearchConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m ElasticsearchConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ElasticsearchConnectionSummary) String() string
func (m ElasticsearchConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ElasticsearchConnectionTechnologyTypeEnum Enum with underlying type: string
type ElasticsearchConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for ElasticsearchConnectionTechnologyTypeEnum
const (
ElasticsearchConnectionTechnologyTypeElasticsearch ElasticsearchConnectionTechnologyTypeEnum = "ELASTICSEARCH"
)
func GetElasticsearchConnectionTechnologyTypeEnumValues() []ElasticsearchConnectionTechnologyTypeEnum
GetElasticsearchConnectionTechnologyTypeEnumValues Enumerates the set of values for ElasticsearchConnectionTechnologyTypeEnum
func GetMappingElasticsearchConnectionTechnologyTypeEnum(val string) (ElasticsearchConnectionTechnologyTypeEnum, bool)
GetMappingElasticsearchConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
EnvironmentTypeEnum Enum with underlying type: string
type EnvironmentTypeEnum string
Set of constants representing the allowable values for EnvironmentTypeEnum
const (
EnvironmentTypeProduction EnvironmentTypeEnum = "PRODUCTION"
EnvironmentTypeDevelopmentOrTesting EnvironmentTypeEnum = "DEVELOPMENT_OR_TESTING"
)
func GetEnvironmentTypeEnumValues() []EnvironmentTypeEnum
GetEnvironmentTypeEnumValues Enumerates the set of values for EnvironmentTypeEnum
func GetMappingEnvironmentTypeEnum(val string) (EnvironmentTypeEnum, bool)
GetMappingEnvironmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ExportDeploymentWalletDetails Metadata required to export wallet from deployment
type ExportDeploymentWalletDetails struct {
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"true" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
MasterEncryptionKeyId *string `mandatory:"true" json:"masterEncryptionKeyId"`
// Name of the secret with which secret is shown in vault
SecretName *string `mandatory:"true" json:"secretName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment, where the secret will be created in.
SecretCompartmentId *string `mandatory:"false" json:"secretCompartmentId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
}
func (m ExportDeploymentWalletDetails) String() string
func (m ExportDeploymentWalletDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportDeploymentWalletRequest wrapper for the ExportDeploymentWallet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ExportDeploymentWallet.go.html to see an example of how to use ExportDeploymentWalletRequest.
type ExportDeploymentWalletRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// Metadata to export the OGG wallet from deployment. This also includes the OCI vault information where the wallet will be exported to
ExportDeploymentWalletDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ExportDeploymentWalletRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExportDeploymentWalletRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportDeploymentWalletRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportDeploymentWalletRequest) String() string
func (request ExportDeploymentWalletRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportDeploymentWalletResponse wrapper for the ExportDeploymentWallet operation
type ExportDeploymentWalletResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ExportDeploymentWalletResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportDeploymentWalletResponse) String() string
GenerateLibraryUrlDetails The information about generating the library URL.
type GenerateLibraryUrlDetails interface {
}
GenerateLibraryUrlRequest wrapper for the GenerateLibraryUrl operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GenerateLibraryUrl.go.html to see an example of how to use GenerateLibraryUrlRequest.
type GenerateLibraryUrlRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A placeholder for any additional metadata to describe the request details.
GenerateLibraryUrlDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GenerateLibraryUrlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateLibraryUrlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateLibraryUrlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateLibraryUrlRequest) String() string
func (request GenerateLibraryUrlRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateLibraryUrlResponse wrapper for the GenerateLibraryUrl operation
type GenerateLibraryUrlResponse struct {
// The underlying http response
RawResponse *http.Response
// The LibraryUrl instance
LibraryUrl `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GenerateLibraryUrlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateLibraryUrlResponse) String() string
GenerateLogReaderComponentLibraryUrlDetails Definition of the additional attributes for default library URL generation.
type GenerateLogReaderComponentLibraryUrlDetails struct {
}
func (m GenerateLogReaderComponentLibraryUrlDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GenerateLogReaderComponentLibraryUrlDetails) String() string
func (m GenerateLogReaderComponentLibraryUrlDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenericConnection Represents the metadata of a Generic Connection.
type GenericConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Host and port separated by colon.
// Example: `"server.example.com:1234"`
// For multiple hosts, provide a comma separated list.
// Example: `"server1.example.com:1000,server1.example.com:2000"`
Host *string `mandatory:"true" json:"host"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The Generic technology type.
TechnologyType GenericConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m GenericConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GenericConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GenericConnection) GetDescription() *string
GetDescription returns Description
func (m GenericConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GenericConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GenericConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GenericConnection) GetId() *string
GetId returns Id
func (m GenericConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GenericConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m GenericConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GenericConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GenericConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GenericConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GenericConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GenericConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GenericConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GenericConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GenericConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GenericConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m GenericConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GenericConnection) String() string
func (m GenericConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenericConnectionSummary Summary of the Generic Connection.
type GenericConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Host and port separated by colon.
// Example: `"server.example.com:1234"`
// For multiple hosts, provide a comma separated list.
// Example: `"server1.example.com:1000,server1.example.com:2000"`
Host *string `mandatory:"true" json:"host"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Generic technology type.
TechnologyType GenericConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m GenericConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GenericConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GenericConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m GenericConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GenericConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GenericConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GenericConnectionSummary) GetId() *string
GetId returns Id
func (m GenericConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GenericConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m GenericConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GenericConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GenericConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GenericConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GenericConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GenericConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GenericConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GenericConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GenericConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GenericConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m GenericConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GenericConnectionSummary) String() string
func (m GenericConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenericConnectionTechnologyTypeEnum Enum with underlying type: string
type GenericConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for GenericConnectionTechnologyTypeEnum
const (
GenericConnectionTechnologyTypeGeneric GenericConnectionTechnologyTypeEnum = "GENERIC"
)
func GetGenericConnectionTechnologyTypeEnumValues() []GenericConnectionTechnologyTypeEnum
GetGenericConnectionTechnologyTypeEnumValues Enumerates the set of values for GenericConnectionTechnologyTypeEnum
func GetMappingGenericConnectionTechnologyTypeEnum(val string) (GenericConnectionTechnologyTypeEnum, bool)
GetMappingGenericConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetCertificateRequest wrapper for the GetCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetCertificate.go.html to see an example of how to use GetCertificateRequest.
type GetCertificateRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A unique certificate identifier.
CertificateKey *string `mandatory:"true" contributesTo:"path" name:"certificateKey"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCertificateRequest) String() string
func (request GetCertificateRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCertificateResponse wrapper for the GetCertificate operation
type GetCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The Certificate instance
Certificate `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCertificateResponse) String() string
GetConnectionAssignmentRequest wrapper for the GetConnectionAssignment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetConnectionAssignment.go.html to see an example of how to use GetConnectionAssignmentRequest.
type GetConnectionAssignmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Connection Assignment.
ConnectionAssignmentId *string `mandatory:"true" contributesTo:"path" name:"connectionAssignmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetConnectionAssignmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConnectionAssignmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConnectionAssignmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConnectionAssignmentRequest) String() string
func (request GetConnectionAssignmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetConnectionAssignmentResponse wrapper for the GetConnectionAssignment operation
type GetConnectionAssignmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The ConnectionAssignment instance
ConnectionAssignment `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetConnectionAssignmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConnectionAssignmentResponse) String() string
GetConnectionRequest wrapper for the GetConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetConnection.go.html to see an example of how to use GetConnectionRequest.
type GetConnectionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Connection.
ConnectionId *string `mandatory:"true" contributesTo:"path" name:"connectionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConnectionRequest) String() string
func (request GetConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetConnectionResponse wrapper for the GetConnection operation
type GetConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Connection instance
Connection `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConnectionResponse) String() string
GetDatabaseRegistrationRequest wrapper for the GetDatabaseRegistration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDatabaseRegistration.go.html to see an example of how to use GetDatabaseRegistrationRequest.
type GetDatabaseRegistrationRequest struct {
// A unique DatabaseRegistration identifier.
DatabaseRegistrationId *string `mandatory:"true" contributesTo:"path" name:"databaseRegistrationId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDatabaseRegistrationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDatabaseRegistrationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDatabaseRegistrationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDatabaseRegistrationRequest) String() string
func (request GetDatabaseRegistrationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDatabaseRegistrationResponse wrapper for the GetDatabaseRegistration operation
type GetDatabaseRegistrationResponse struct {
// The underlying http response
RawResponse *http.Response
// The DatabaseRegistration instance
DatabaseRegistration `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Deprecation date of this API version.
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response GetDatabaseRegistrationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDatabaseRegistrationResponse) String() string
GetDeploymentBackupRequest wrapper for the GetDeploymentBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDeploymentBackup.go.html to see an example of how to use GetDeploymentBackupRequest.
type GetDeploymentBackupRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDeploymentBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDeploymentBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDeploymentBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDeploymentBackupRequest) String() string
func (request GetDeploymentBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDeploymentBackupResponse wrapper for the GetDeploymentBackup operation
type GetDeploymentBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentBackup instance
DeploymentBackup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetDeploymentBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDeploymentBackupResponse) String() string
GetDeploymentRequest wrapper for the GetDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDeployment.go.html to see an example of how to use GetDeploymentRequest.
type GetDeploymentRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDeploymentRequest) String() string
func (request GetDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDeploymentResponse wrapper for the GetDeployment operation
type GetDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The Deployment instance
Deployment `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDeploymentResponse) String() string
GetDeploymentUpgradeRequest wrapper for the GetDeploymentUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDeploymentUpgrade.go.html to see an example of how to use GetDeploymentUpgradeRequest.
type GetDeploymentUpgradeRequest struct {
// A unique Deployment Upgrade identifier.
DeploymentUpgradeId *string `mandatory:"true" contributesTo:"path" name:"deploymentUpgradeId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDeploymentUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDeploymentUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDeploymentUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDeploymentUpgradeRequest) String() string
func (request GetDeploymentUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDeploymentUpgradeResponse wrapper for the GetDeploymentUpgrade operation
type GetDeploymentUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentUpgrade instance
DeploymentUpgrade `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetDeploymentUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDeploymentUpgradeResponse) String() string
GetPipelineRequest wrapper for the GetPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetPipeline.go.html to see an example of how to use GetPipelineRequest.
type GetPipelineRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPipelineRequest) String() string
func (request GetPipelineRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPipelineResponse wrapper for the GetPipeline operation
type GetPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// The Pipeline instance
Pipeline `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPipelineResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
GoldenGateClient a client for GoldenGate
type GoldenGateClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGoldenGateClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GoldenGateClient, err error)
NewGoldenGateClientWithConfigurationProvider Creates a new default GoldenGate client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGoldenGateClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GoldenGateClient, err error)
NewGoldenGateClientWithOboToken Creates a new default GoldenGate client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client GoldenGateClient) AddConnectionLock(ctx context.Context, request AddConnectionLockRequest) (response AddConnectionLockResponse, err error)
AddConnectionLock Adds a lock to a Connection resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/AddConnectionLock.go.html to see an example of how to use AddConnectionLock API. A default retry strategy applies to this operation AddConnectionLock()
func (client GoldenGateClient) AddDeploymentBackupLock(ctx context.Context, request AddDeploymentBackupLockRequest) (response AddDeploymentBackupLockResponse, err error)
AddDeploymentBackupLock Adds a lock to a DeploymentBackup resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/AddDeploymentBackupLock.go.html to see an example of how to use AddDeploymentBackupLock API. A default retry strategy applies to this operation AddDeploymentBackupLock()
func (client GoldenGateClient) AddDeploymentLock(ctx context.Context, request AddDeploymentLockRequest) (response AddDeploymentLockResponse, err error)
AddDeploymentLock Adds a lock to a Deployment resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/AddDeploymentLock.go.html to see an example of how to use AddDeploymentLock API. A default retry strategy applies to this operation AddDeploymentLock()
func (client GoldenGateClient) CancelDeploymentBackup(ctx context.Context, request CancelDeploymentBackupRequest) (response CancelDeploymentBackupResponse, err error)
CancelDeploymentBackup Cancels a Deployment Backup creation process.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CancelDeploymentBackup.go.html to see an example of how to use CancelDeploymentBackup API. A default retry strategy applies to this operation CancelDeploymentBackup()
func (client GoldenGateClient) CancelDeploymentUpgrade(ctx context.Context, request CancelDeploymentUpgradeRequest) (response CancelDeploymentUpgradeResponse, err error)
CancelDeploymentUpgrade Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CancelDeploymentUpgrade.go.html to see an example of how to use CancelDeploymentUpgrade API. A default retry strategy applies to this operation CancelDeploymentUpgrade()
func (client GoldenGateClient) CancelSnoozeDeploymentUpgrade(ctx context.Context, request CancelSnoozeDeploymentUpgradeRequest) (response CancelSnoozeDeploymentUpgradeResponse, err error)
CancelSnoozeDeploymentUpgrade Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CancelSnoozeDeploymentUpgrade.go.html to see an example of how to use CancelSnoozeDeploymentUpgrade API. A default retry strategy applies to this operation CancelSnoozeDeploymentUpgrade()
func (client GoldenGateClient) ChangeConnectionCompartment(ctx context.Context, request ChangeConnectionCompartmentRequest) (response ChangeConnectionCompartmentResponse, err error)
ChangeConnectionCompartment Moves the Connection into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeConnectionCompartment.go.html to see an example of how to use ChangeConnectionCompartment API. A default retry strategy applies to this operation ChangeConnectionCompartment()
func (client GoldenGateClient) ChangeDatabaseRegistrationCompartment(ctx context.Context, request ChangeDatabaseRegistrationCompartmentRequest) (response ChangeDatabaseRegistrationCompartmentResponse, err error)
ChangeDatabaseRegistrationCompartment Note: Deprecated. Use the /connections API instead. Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeDatabaseRegistrationCompartment.go.html to see an example of how to use ChangeDatabaseRegistrationCompartment API. A default retry strategy applies to this operation ChangeDatabaseRegistrationCompartment()
func (client GoldenGateClient) ChangeDeploymentBackupCompartment(ctx context.Context, request ChangeDeploymentBackupCompartmentRequest) (response ChangeDeploymentBackupCompartmentResponse, err error)
ChangeDeploymentBackupCompartment Moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeDeploymentBackupCompartment.go.html to see an example of how to use ChangeDeploymentBackupCompartment API. A default retry strategy applies to this operation ChangeDeploymentBackupCompartment()
func (client GoldenGateClient) ChangeDeploymentCompartment(ctx context.Context, request ChangeDeploymentCompartmentRequest) (response ChangeDeploymentCompartmentResponse, err error)
ChangeDeploymentCompartment Moves the Deployment into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangeDeploymentCompartment.go.html to see an example of how to use ChangeDeploymentCompartment API. A default retry strategy applies to this operation ChangeDeploymentCompartment()
func (client GoldenGateClient) ChangePipelineCompartment(ctx context.Context, request ChangePipelineCompartmentRequest) (response ChangePipelineCompartmentResponse, err error)
ChangePipelineCompartment Moves the Pipeline into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ChangePipelineCompartment.go.html to see an example of how to use ChangePipelineCompartment API. A default retry strategy applies to this operation ChangePipelineCompartment()
func (client GoldenGateClient) CollectDeploymentDiagnostic(ctx context.Context, request CollectDeploymentDiagnosticRequest) (response CollectDeploymentDiagnosticResponse, err error)
CollectDeploymentDiagnostic Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CollectDeploymentDiagnostic.go.html to see an example of how to use CollectDeploymentDiagnostic API. A default retry strategy applies to this operation CollectDeploymentDiagnostic()
func (client *GoldenGateClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GoldenGateClient) CopyDeploymentBackup(ctx context.Context, request CopyDeploymentBackupRequest) (response CopyDeploymentBackupResponse, err error)
CopyDeploymentBackup Creates a copy of a Deployment Backup.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CopyDeploymentBackup.go.html to see an example of how to use CopyDeploymentBackup API. A default retry strategy applies to this operation CopyDeploymentBackup()
func (client GoldenGateClient) CreateCertificate(ctx context.Context, request CreateCertificateRequest) (response CreateCertificateResponse, err error)
CreateCertificate Creates a new certificate to truststore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateCertificate.go.html to see an example of how to use CreateCertificate API. A default retry strategy applies to this operation CreateCertificate()
func (client GoldenGateClient) CreateConnection(ctx context.Context, request CreateConnectionRequest) (response CreateConnectionResponse, err error)
CreateConnection Creates a new Connection.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateConnection.go.html to see an example of how to use CreateConnection API. A default retry strategy applies to this operation CreateConnection()
func (client GoldenGateClient) CreateConnectionAssignment(ctx context.Context, request CreateConnectionAssignmentRequest) (response CreateConnectionAssignmentResponse, err error)
CreateConnectionAssignment Creates a new Connection Assignment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateConnectionAssignment.go.html to see an example of how to use CreateConnectionAssignment API. A default retry strategy applies to this operation CreateConnectionAssignment()
func (client GoldenGateClient) CreateDatabaseRegistration(ctx context.Context, request CreateDatabaseRegistrationRequest) (response CreateDatabaseRegistrationResponse, err error)
CreateDatabaseRegistration Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateDatabaseRegistration.go.html to see an example of how to use CreateDatabaseRegistration API. A default retry strategy applies to this operation CreateDatabaseRegistration()
func (client GoldenGateClient) CreateDeployment(ctx context.Context, request CreateDeploymentRequest) (response CreateDeploymentResponse, err error)
CreateDeployment Creates a new Deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateDeployment.go.html to see an example of how to use CreateDeployment API. A default retry strategy applies to this operation CreateDeployment()
func (client GoldenGateClient) CreateDeploymentBackup(ctx context.Context, request CreateDeploymentBackupRequest) (response CreateDeploymentBackupResponse, err error)
CreateDeploymentBackup Creates a new DeploymentBackup.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreateDeploymentBackup.go.html to see an example of how to use CreateDeploymentBackup API. A default retry strategy applies to this operation CreateDeploymentBackup()
func (client GoldenGateClient) CreatePipeline(ctx context.Context, request CreatePipelineRequest) (response CreatePipelineResponse, err error)
CreatePipeline Creates a new Pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/CreatePipeline.go.html to see an example of how to use CreatePipeline API. A default retry strategy applies to this operation CreatePipeline()
func (client GoldenGateClient) DeleteCertificate(ctx context.Context, request DeleteCertificateRequest) (response DeleteCertificateResponse, err error)
DeleteCertificate Deletes the certificate from truststore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteCertificate.go.html to see an example of how to use DeleteCertificate API. A default retry strategy applies to this operation DeleteCertificate()
func (client GoldenGateClient) DeleteConnection(ctx context.Context, request DeleteConnectionRequest) (response DeleteConnectionResponse, err error)
DeleteConnection Deletes a Connection.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteConnection.go.html to see an example of how to use DeleteConnection API. A default retry strategy applies to this operation DeleteConnection()
func (client GoldenGateClient) DeleteConnectionAssignment(ctx context.Context, request DeleteConnectionAssignmentRequest) (response DeleteConnectionAssignmentResponse, err error)
DeleteConnectionAssignment Deletes a Connection Assignment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteConnectionAssignment.go.html to see an example of how to use DeleteConnectionAssignment API. A default retry strategy applies to this operation DeleteConnectionAssignment()
func (client GoldenGateClient) DeleteDatabaseRegistration(ctx context.Context, request DeleteDatabaseRegistrationRequest) (response DeleteDatabaseRegistrationResponse, err error)
DeleteDatabaseRegistration Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteDatabaseRegistration.go.html to see an example of how to use DeleteDatabaseRegistration API. A default retry strategy applies to this operation DeleteDatabaseRegistration()
func (client GoldenGateClient) DeleteDeployment(ctx context.Context, request DeleteDeploymentRequest) (response DeleteDeploymentResponse, err error)
DeleteDeployment Deletes the Deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteDeployment.go.html to see an example of how to use DeleteDeployment API. A default retry strategy applies to this operation DeleteDeployment()
func (client GoldenGateClient) DeleteDeploymentBackup(ctx context.Context, request DeleteDeploymentBackupRequest) (response DeleteDeploymentBackupResponse, err error)
DeleteDeploymentBackup Deletes a DeploymentBackup.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeleteDeploymentBackup.go.html to see an example of how to use DeleteDeploymentBackup API. A default retry strategy applies to this operation DeleteDeploymentBackup()
func (client GoldenGateClient) DeletePipeline(ctx context.Context, request DeletePipelineRequest) (response DeletePipelineResponse, err error)
DeletePipeline Deletes a Pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeletePipeline.go.html to see an example of how to use DeletePipeline API. A default retry strategy applies to this operation DeletePipeline()
func (client GoldenGateClient) DeploymentWalletExists(ctx context.Context, request DeploymentWalletExistsRequest) (response DeploymentWalletExistsResponse, err error)
DeploymentWalletExists Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/DeploymentWalletExists.go.html to see an example of how to use DeploymentWalletExists API. A default retry strategy applies to this operation DeploymentWalletExists()
func (client GoldenGateClient) ExportDeploymentWallet(ctx context.Context, request ExportDeploymentWalletRequest) (response ExportDeploymentWalletResponse, err error)
ExportDeploymentWallet Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ExportDeploymentWallet.go.html to see an example of how to use ExportDeploymentWallet API. A default retry strategy applies to this operation ExportDeploymentWallet()
func (client GoldenGateClient) GenerateLibraryUrl(ctx context.Context, request GenerateLibraryUrlRequest) (response GenerateLibraryUrlResponse, err error)
GenerateLibraryUrl Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GenerateLibraryUrl.go.html to see an example of how to use GenerateLibraryUrl API. A default retry strategy applies to this operation GenerateLibraryUrl()
func (client GoldenGateClient) GetCertificate(ctx context.Context, request GetCertificateRequest) (response GetCertificateResponse, err error)
GetCertificate Retrieves a Certificate.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetCertificate.go.html to see an example of how to use GetCertificate API. A default retry strategy applies to this operation GetCertificate()
func (client GoldenGateClient) GetConnection(ctx context.Context, request GetConnectionRequest) (response GetConnectionResponse, err error)
GetConnection Retrieves a Connection.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetConnection.go.html to see an example of how to use GetConnection API. A default retry strategy applies to this operation GetConnection()
func (client GoldenGateClient) GetConnectionAssignment(ctx context.Context, request GetConnectionAssignmentRequest) (response GetConnectionAssignmentResponse, err error)
GetConnectionAssignment Retrieves a Connection Assignment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetConnectionAssignment.go.html to see an example of how to use GetConnectionAssignment API. A default retry strategy applies to this operation GetConnectionAssignment()
func (client GoldenGateClient) GetDatabaseRegistration(ctx context.Context, request GetDatabaseRegistrationRequest) (response GetDatabaseRegistrationResponse, err error)
GetDatabaseRegistration Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDatabaseRegistration.go.html to see an example of how to use GetDatabaseRegistration API. A default retry strategy applies to this operation GetDatabaseRegistration()
func (client GoldenGateClient) GetDeployment(ctx context.Context, request GetDeploymentRequest) (response GetDeploymentResponse, err error)
GetDeployment Retrieves a deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDeployment.go.html to see an example of how to use GetDeployment API. A default retry strategy applies to this operation GetDeployment()
func (client GoldenGateClient) GetDeploymentBackup(ctx context.Context, request GetDeploymentBackupRequest) (response GetDeploymentBackupResponse, err error)
GetDeploymentBackup Retrieves a DeploymentBackup.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDeploymentBackup.go.html to see an example of how to use GetDeploymentBackup API. A default retry strategy applies to this operation GetDeploymentBackup()
func (client GoldenGateClient) GetDeploymentUpgrade(ctx context.Context, request GetDeploymentUpgradeRequest) (response GetDeploymentUpgradeResponse, err error)
GetDeploymentUpgrade Retrieves a deployment upgrade.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetDeploymentUpgrade.go.html to see an example of how to use GetDeploymentUpgrade API. A default retry strategy applies to this operation GetDeploymentUpgrade()
func (client GoldenGateClient) GetPipeline(ctx context.Context, request GetPipelineRequest) (response GetPipelineResponse, err error)
GetPipeline Retrieves a Pipeline details.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetPipeline.go.html to see an example of how to use GetPipeline API. A default retry strategy applies to this operation GetPipeline()
func (client GoldenGateClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Retrieve the WorkRequest identified by the given OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client GoldenGateClient) ImportDeploymentWallet(ctx context.Context, request ImportDeploymentWalletRequest) (response ImportDeploymentWalletResponse, err error)
ImportDeploymentWallet Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ImportDeploymentWallet.go.html to see an example of how to use ImportDeploymentWallet API. A default retry strategy applies to this operation ImportDeploymentWallet()
func (client GoldenGateClient) ListCertificates(ctx context.Context, request ListCertificatesRequest) (response ListCertificatesResponse, err error)
ListCertificates Returns a list of certificates from truststore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListCertificates.go.html to see an example of how to use ListCertificates API. A default retry strategy applies to this operation ListCertificates()
func (client GoldenGateClient) ListConnectionAssignments(ctx context.Context, request ListConnectionAssignmentsRequest) (response ListConnectionAssignmentsResponse, err error)
ListConnectionAssignments Lists the Connection Assignments in the compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListConnectionAssignments.go.html to see an example of how to use ListConnectionAssignments API. A default retry strategy applies to this operation ListConnectionAssignments()
func (client GoldenGateClient) ListConnections(ctx context.Context, request ListConnectionsRequest) (response ListConnectionsResponse, err error)
ListConnections Lists the Connections in the compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListConnections.go.html to see an example of how to use ListConnections API. A default retry strategy applies to this operation ListConnections()
func (client GoldenGateClient) ListDatabaseRegistrations(ctx context.Context, request ListDatabaseRegistrationsRequest) (response ListDatabaseRegistrationsResponse, err error)
ListDatabaseRegistrations Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDatabaseRegistrations.go.html to see an example of how to use ListDatabaseRegistrations API. A default retry strategy applies to this operation ListDatabaseRegistrations()
func (client GoldenGateClient) ListDeploymentBackups(ctx context.Context, request ListDeploymentBackupsRequest) (response ListDeploymentBackupsResponse, err error)
ListDeploymentBackups Lists the Backups in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentBackups.go.html to see an example of how to use ListDeploymentBackups API. A default retry strategy applies to this operation ListDeploymentBackups()
func (client GoldenGateClient) ListDeploymentEnvironments(ctx context.Context, request ListDeploymentEnvironmentsRequest) (response ListDeploymentEnvironmentsResponse, err error)
ListDeploymentEnvironments Returns an array of DeploymentEnvironmentDescriptor
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentEnvironments.go.html to see an example of how to use ListDeploymentEnvironments API. A default retry strategy applies to this operation ListDeploymentEnvironments()
func (client GoldenGateClient) ListDeploymentTypes(ctx context.Context, request ListDeploymentTypesRequest) (response ListDeploymentTypesResponse, err error)
ListDeploymentTypes Returns an array of DeploymentTypeDescriptor
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentTypes.go.html to see an example of how to use ListDeploymentTypes API. A default retry strategy applies to this operation ListDeploymentTypes()
func (client GoldenGateClient) ListDeploymentUpgrades(ctx context.Context, request ListDeploymentUpgradesRequest) (response ListDeploymentUpgradesResponse, err error)
ListDeploymentUpgrades Lists the Deployment Upgrades in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentUpgrades.go.html to see an example of how to use ListDeploymentUpgrades API. A default retry strategy applies to this operation ListDeploymentUpgrades()
func (client GoldenGateClient) ListDeploymentVersions(ctx context.Context, request ListDeploymentVersionsRequest) (response ListDeploymentVersionsResponse, err error)
ListDeploymentVersions Returns the list of available deployment versions.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentVersions.go.html to see an example of how to use ListDeploymentVersions API. A default retry strategy applies to this operation ListDeploymentVersions()
func (client GoldenGateClient) ListDeploymentWalletsOperations(ctx context.Context, request ListDeploymentWalletsOperationsRequest) (response ListDeploymentWalletsOperationsResponse, err error)
ListDeploymentWalletsOperations Lists the wallets export/import operations to/from a deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentWalletsOperations.go.html to see an example of how to use ListDeploymentWalletsOperations API. A default retry strategy applies to this operation ListDeploymentWalletsOperations()
func (client GoldenGateClient) ListDeployments(ctx context.Context, request ListDeploymentsRequest) (response ListDeploymentsResponse, err error)
ListDeployments Lists the Deployments in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeployments.go.html to see an example of how to use ListDeployments API. A default retry strategy applies to this operation ListDeployments()
func (client GoldenGateClient) ListMessages(ctx context.Context, request ListMessagesRequest) (response ListMessagesResponse, err error)
ListMessages Lists the DeploymentMessages for a deployment. The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListMessages.go.html to see an example of how to use ListMessages API. A default retry strategy applies to this operation ListMessages()
func (client GoldenGateClient) ListPipelineInitializationSteps(ctx context.Context, request ListPipelineInitializationStepsRequest) (response ListPipelineInitializationStepsResponse, err error)
ListPipelineInitializationSteps Retrieves a Pipeline recipe steps and its progress details.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineInitializationSteps.go.html to see an example of how to use ListPipelineInitializationSteps API. A default retry strategy applies to this operation ListPipelineInitializationSteps()
func (client GoldenGateClient) ListPipelineRunningProcesses(ctx context.Context, request ListPipelineRunningProcessesRequest) (response ListPipelineRunningProcessesResponse, err error)
ListPipelineRunningProcesses Retrieves a Pipeline's running replication process's status like extracts/replicats.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineRunningProcesses.go.html to see an example of how to use ListPipelineRunningProcesses API. A default retry strategy applies to this operation ListPipelineRunningProcesses()
func (client GoldenGateClient) ListPipelineSchemaTables(ctx context.Context, request ListPipelineSchemaTablesRequest) (response ListPipelineSchemaTablesResponse, err error)
ListPipelineSchemaTables Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineSchemaTables.go.html to see an example of how to use ListPipelineSchemaTables API. A default retry strategy applies to this operation ListPipelineSchemaTables()
func (client GoldenGateClient) ListPipelineSchemas(ctx context.Context, request ListPipelineSchemasRequest) (response ListPipelineSchemasResponse, err error)
ListPipelineSchemas Returns an array of schemas based on mapping rules for a pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineSchemas.go.html to see an example of how to use ListPipelineSchemas API. A default retry strategy applies to this operation ListPipelineSchemas()
func (client GoldenGateClient) ListPipelines(ctx context.Context, request ListPipelinesRequest) (response ListPipelinesResponse, err error)
ListPipelines Lists the Pipelines in the compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelines.go.html to see an example of how to use ListPipelines API. A default retry strategy applies to this operation ListPipelines()
func (client GoldenGateClient) ListRecipes(ctx context.Context, request ListRecipesRequest) (response ListRecipesResponse, err error)
ListRecipes Returns an array of Recipe Summary.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListRecipes.go.html to see an example of how to use ListRecipes API. A default retry strategy applies to this operation ListRecipes()
func (client GoldenGateClient) ListTrailFiles(ctx context.Context, request ListTrailFilesRequest) (response ListTrailFilesResponse, err error)
ListTrailFiles Lists the TrailFiles for a deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListTrailFiles.go.html to see an example of how to use ListTrailFiles API. A default retry strategy applies to this operation ListTrailFiles()
func (client GoldenGateClient) ListTrailSequences(ctx context.Context, request ListTrailSequencesRequest) (response ListTrailSequencesResponse, err error)
ListTrailSequences Lists the Trail Sequences for a TrailFile in a given deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListTrailSequences.go.html to see an example of how to use ListTrailSequences API. A default retry strategy applies to this operation ListTrailSequences()
func (client GoldenGateClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists work request errors.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client GoldenGateClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists work request logs.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client GoldenGateClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in the compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client GoldenGateClient) RefreshConnection(ctx context.Context, request RefreshConnectionRequest) (response RefreshConnectionResponse, err error)
RefreshConnection Refresh the external Connection attributes.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RefreshConnection.go.html to see an example of how to use RefreshConnection API. A default retry strategy applies to this operation RefreshConnection()
func (client GoldenGateClient) RemoveConnectionLock(ctx context.Context, request RemoveConnectionLockRequest) (response RemoveConnectionLockResponse, err error)
RemoveConnectionLock Removes a lock from a Connection resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RemoveConnectionLock.go.html to see an example of how to use RemoveConnectionLock API. A default retry strategy applies to this operation RemoveConnectionLock()
func (client GoldenGateClient) RemoveDeploymentBackupLock(ctx context.Context, request RemoveDeploymentBackupLockRequest) (response RemoveDeploymentBackupLockResponse, err error)
RemoveDeploymentBackupLock Removes a lock from a DeploymentBackup resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RemoveDeploymentBackupLock.go.html to see an example of how to use RemoveDeploymentBackupLock API. A default retry strategy applies to this operation RemoveDeploymentBackupLock()
func (client GoldenGateClient) RemoveDeploymentLock(ctx context.Context, request RemoveDeploymentLockRequest) (response RemoveDeploymentLockResponse, err error)
RemoveDeploymentLock Removes a lock from a Deployment resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RemoveDeploymentLock.go.html to see an example of how to use RemoveDeploymentLock API. A default retry strategy applies to this operation RemoveDeploymentLock()
func (client GoldenGateClient) RescheduleDeploymentUpgrade(ctx context.Context, request RescheduleDeploymentUpgradeRequest) (response RescheduleDeploymentUpgradeResponse, err error)
RescheduleDeploymentUpgrade Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RescheduleDeploymentUpgrade.go.html to see an example of how to use RescheduleDeploymentUpgrade API. A default retry strategy applies to this operation RescheduleDeploymentUpgrade()
func (client GoldenGateClient) RestoreDeployment(ctx context.Context, request RestoreDeploymentRequest) (response RestoreDeploymentResponse, err error)
RestoreDeployment Restores a Deployment from a Deployment Backup created from the same Deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RestoreDeployment.go.html to see an example of how to use RestoreDeployment API. A default retry strategy applies to this operation RestoreDeployment()
func (client GoldenGateClient) RollbackDeploymentUpgrade(ctx context.Context, request RollbackDeploymentUpgradeRequest) (response RollbackDeploymentUpgradeResponse, err error)
RollbackDeploymentUpgrade Rollback a deployment to it's previous version. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RollbackDeploymentUpgrade.go.html to see an example of how to use RollbackDeploymentUpgrade API. A default retry strategy applies to this operation RollbackDeploymentUpgrade()
func (client *GoldenGateClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GoldenGateClient) SnoozeDeploymentUpgrade(ctx context.Context, request SnoozeDeploymentUpgradeRequest) (response SnoozeDeploymentUpgradeResponse, err error)
SnoozeDeploymentUpgrade Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/SnoozeDeploymentUpgrade.go.html to see an example of how to use SnoozeDeploymentUpgrade API. A default retry strategy applies to this operation SnoozeDeploymentUpgrade()
func (client GoldenGateClient) StartDeployment(ctx context.Context, request StartDeploymentRequest) (response StartDeploymentResponse, err error)
StartDeployment Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StartDeployment.go.html to see an example of how to use StartDeployment API. A default retry strategy applies to this operation StartDeployment()
func (client GoldenGateClient) StartPipeline(ctx context.Context, request StartPipelineRequest) (response StartPipelineResponse, err error)
StartPipeline Starts the pipeline for data replication.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StartPipeline.go.html to see an example of how to use StartPipeline API. A default retry strategy applies to this operation StartPipeline()
func (client GoldenGateClient) StopDeployment(ctx context.Context, request StopDeploymentRequest) (response StopDeploymentResponse, err error)
StopDeployment Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StopDeployment.go.html to see an example of how to use StopDeployment API. A default retry strategy applies to this operation StopDeployment()
func (client GoldenGateClient) StopPipeline(ctx context.Context, request StopPipelineRequest) (response StopPipelineResponse, err error)
StopPipeline Stops the pipeline for data replication.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StopPipeline.go.html to see an example of how to use StopPipeline API. A default retry strategy applies to this operation StopPipeline()
func (client GoldenGateClient) TestConnectionAssignment(ctx context.Context, request TestConnectionAssignmentRequest) (response TestConnectionAssignmentResponse, err error)
TestConnectionAssignment Tests the connectivity between given GoldenGate deployment and one of the associated database / service. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/TestConnectionAssignment.go.html to see an example of how to use TestConnectionAssignment API. A default retry strategy applies to this operation TestConnectionAssignment()
func (client GoldenGateClient) TestPipelineConnection(ctx context.Context, request TestPipelineConnectionRequest) (response TestPipelineConnectionResponse, err error)
TestPipelineConnection Tests pipeline connections against pipeline to verify the connectivity. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/TestPipelineConnection.go.html to see an example of how to use TestPipelineConnection API. A default retry strategy applies to this operation TestPipelineConnection()
func (client GoldenGateClient) UpdateConnection(ctx context.Context, request UpdateConnectionRequest) (response UpdateConnectionResponse, err error)
UpdateConnection Updates the Connection.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateConnection.go.html to see an example of how to use UpdateConnection API. A default retry strategy applies to this operation UpdateConnection()
func (client GoldenGateClient) UpdateDatabaseRegistration(ctx context.Context, request UpdateDatabaseRegistrationRequest) (response UpdateDatabaseRegistrationResponse, err error)
UpdateDatabaseRegistration Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateDatabaseRegistration.go.html to see an example of how to use UpdateDatabaseRegistration API. A default retry strategy applies to this operation UpdateDatabaseRegistration()
func (client GoldenGateClient) UpdateDeployment(ctx context.Context, request UpdateDeploymentRequest) (response UpdateDeploymentResponse, err error)
UpdateDeployment Modifies a Deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateDeployment.go.html to see an example of how to use UpdateDeployment API. A default retry strategy applies to this operation UpdateDeployment()
func (client GoldenGateClient) UpdateDeploymentBackup(ctx context.Context, request UpdateDeploymentBackupRequest) (response UpdateDeploymentBackupResponse, err error)
UpdateDeploymentBackup Modifies a Deployment Backup.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateDeploymentBackup.go.html to see an example of how to use UpdateDeploymentBackup API. A default retry strategy applies to this operation UpdateDeploymentBackup()
func (client GoldenGateClient) UpdatePipeline(ctx context.Context, request UpdatePipelineRequest) (response UpdatePipelineResponse, err error)
UpdatePipeline Updates the Pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdatePipeline.go.html to see an example of how to use UpdatePipeline API. A default retry strategy applies to this operation UpdatePipeline()
func (client GoldenGateClient) UpgradeDeployment(ctx context.Context, request UpgradeDeploymentRequest) (response UpgradeDeploymentResponse, err error)
UpgradeDeployment Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpgradeDeployment.go.html to see an example of how to use UpgradeDeployment API. A default retry strategy applies to this operation UpgradeDeployment()
func (client GoldenGateClient) UpgradeDeploymentUpgrade(ctx context.Context, request UpgradeDeploymentUpgradeRequest) (response UpgradeDeploymentUpgradeResponse, err error)
UpgradeDeploymentUpgrade Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpgradeDeploymentUpgrade.go.html to see an example of how to use UpgradeDeploymentUpgrade API. A default retry strategy applies to this operation UpgradeDeploymentUpgrade()
GoldenGateConnection Represents the metadata of a GoldenGate Connection.
type GoldenGateConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"false" json:"deploymentId"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The username credential existing in the Oracle GoldenGate used to be connected to.
Username *string `mandatory:"false" json:"username"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// which is used to connect to the Oracle GoldenGate accessed trough this connection.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The GoldenGate technology type.
TechnologyType GoldenGateConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m GoldenGateConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GoldenGateConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GoldenGateConnection) GetDescription() *string
GetDescription returns Description
func (m GoldenGateConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GoldenGateConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GoldenGateConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GoldenGateConnection) GetId() *string
GetId returns Id
func (m GoldenGateConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GoldenGateConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m GoldenGateConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GoldenGateConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GoldenGateConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GoldenGateConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GoldenGateConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GoldenGateConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GoldenGateConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GoldenGateConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GoldenGateConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GoldenGateConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m GoldenGateConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GoldenGateConnection) String() string
func (m GoldenGateConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GoldenGateConnectionSummary Summary of the GoldenGate Connection.
type GoldenGateConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"false" json:"deploymentId"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The username credential existing in the Oracle GoldenGate used to be connected to.
Username *string `mandatory:"false" json:"username"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// which is used to connect to the Oracle GoldenGate accessed trough this connection.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The GoldenGate technology type.
TechnologyType GoldenGateConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m GoldenGateConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GoldenGateConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GoldenGateConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m GoldenGateConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GoldenGateConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GoldenGateConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GoldenGateConnectionSummary) GetId() *string
GetId returns Id
func (m GoldenGateConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GoldenGateConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m GoldenGateConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GoldenGateConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GoldenGateConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GoldenGateConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GoldenGateConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GoldenGateConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GoldenGateConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GoldenGateConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GoldenGateConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GoldenGateConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m GoldenGateConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GoldenGateConnectionSummary) String() string
func (m GoldenGateConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GoldenGateConnectionTechnologyTypeEnum Enum with underlying type: string
type GoldenGateConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for GoldenGateConnectionTechnologyTypeEnum
const (
GoldenGateConnectionTechnologyTypeGoldengate GoldenGateConnectionTechnologyTypeEnum = "GOLDENGATE"
)
func GetGoldenGateConnectionTechnologyTypeEnumValues() []GoldenGateConnectionTechnologyTypeEnum
GetGoldenGateConnectionTechnologyTypeEnumValues Enumerates the set of values for GoldenGateConnectionTechnologyTypeEnum
func GetMappingGoldenGateConnectionTechnologyTypeEnum(val string) (GoldenGateConnectionTechnologyTypeEnum, bool)
GetMappingGoldenGateConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GoogleBigQueryConnection Represents the metadata of a Google BigQuery Connection.
type GoogleBigQueryConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google BigQuery.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// The Google BigQuery technology type.
TechnologyType GoogleBigQueryConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m GoogleBigQueryConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GoogleBigQueryConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GoogleBigQueryConnection) GetDescription() *string
GetDescription returns Description
func (m GoogleBigQueryConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GoogleBigQueryConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GoogleBigQueryConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GoogleBigQueryConnection) GetId() *string
GetId returns Id
func (m GoogleBigQueryConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GoogleBigQueryConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m GoogleBigQueryConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GoogleBigQueryConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GoogleBigQueryConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GoogleBigQueryConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GoogleBigQueryConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GoogleBigQueryConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GoogleBigQueryConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GoogleBigQueryConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GoogleBigQueryConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GoogleBigQueryConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m GoogleBigQueryConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GoogleBigQueryConnection) String() string
func (m GoogleBigQueryConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GoogleBigQueryConnectionSummary Summary of the Google BigQuery Connection.
type GoogleBigQueryConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google BigQuery.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Google BigQuery technology type.
TechnologyType GoogleBigQueryConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m GoogleBigQueryConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GoogleBigQueryConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GoogleBigQueryConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m GoogleBigQueryConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GoogleBigQueryConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GoogleBigQueryConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GoogleBigQueryConnectionSummary) GetId() *string
GetId returns Id
func (m GoogleBigQueryConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GoogleBigQueryConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m GoogleBigQueryConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GoogleBigQueryConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GoogleBigQueryConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GoogleBigQueryConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GoogleBigQueryConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GoogleBigQueryConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GoogleBigQueryConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GoogleBigQueryConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GoogleBigQueryConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GoogleBigQueryConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m GoogleBigQueryConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GoogleBigQueryConnectionSummary) String() string
func (m GoogleBigQueryConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GoogleBigQueryConnectionTechnologyTypeEnum Enum with underlying type: string
type GoogleBigQueryConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for GoogleBigQueryConnectionTechnologyTypeEnum
const (
GoogleBigQueryConnectionTechnologyTypeGoogleBigquery GoogleBigQueryConnectionTechnologyTypeEnum = "GOOGLE_BIGQUERY"
)
func GetGoogleBigQueryConnectionTechnologyTypeEnumValues() []GoogleBigQueryConnectionTechnologyTypeEnum
GetGoogleBigQueryConnectionTechnologyTypeEnumValues Enumerates the set of values for GoogleBigQueryConnectionTechnologyTypeEnum
func GetMappingGoogleBigQueryConnectionTechnologyTypeEnum(val string) (GoogleBigQueryConnectionTechnologyTypeEnum, bool)
GetMappingGoogleBigQueryConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GoogleCloudStorageConnection Represents the metadata of a Google Cloud Storage Connection.
type GoogleCloudStorageConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google Cloud Storage.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// The Google Cloud Storage technology type.
TechnologyType GoogleCloudStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m GoogleCloudStorageConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GoogleCloudStorageConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GoogleCloudStorageConnection) GetDescription() *string
GetDescription returns Description
func (m GoogleCloudStorageConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GoogleCloudStorageConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GoogleCloudStorageConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GoogleCloudStorageConnection) GetId() *string
GetId returns Id
func (m GoogleCloudStorageConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GoogleCloudStorageConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m GoogleCloudStorageConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GoogleCloudStorageConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GoogleCloudStorageConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GoogleCloudStorageConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GoogleCloudStorageConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GoogleCloudStorageConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GoogleCloudStorageConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GoogleCloudStorageConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GoogleCloudStorageConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GoogleCloudStorageConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m GoogleCloudStorageConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GoogleCloudStorageConnection) String() string
func (m GoogleCloudStorageConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GoogleCloudStorageConnectionSummary Summary of the Google Cloud Storage Connection.
type GoogleCloudStorageConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google Cloud Storage.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Google Cloud Storage technology type.
TechnologyType GoogleCloudStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m GoogleCloudStorageConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GoogleCloudStorageConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GoogleCloudStorageConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m GoogleCloudStorageConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GoogleCloudStorageConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GoogleCloudStorageConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GoogleCloudStorageConnectionSummary) GetId() *string
GetId returns Id
func (m GoogleCloudStorageConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GoogleCloudStorageConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m GoogleCloudStorageConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GoogleCloudStorageConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GoogleCloudStorageConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GoogleCloudStorageConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GoogleCloudStorageConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GoogleCloudStorageConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GoogleCloudStorageConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GoogleCloudStorageConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GoogleCloudStorageConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GoogleCloudStorageConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m GoogleCloudStorageConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GoogleCloudStorageConnectionSummary) String() string
func (m GoogleCloudStorageConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GoogleCloudStorageConnectionTechnologyTypeEnum Enum with underlying type: string
type GoogleCloudStorageConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for GoogleCloudStorageConnectionTechnologyTypeEnum
const (
GoogleCloudStorageConnectionTechnologyTypeGoogleCloudStorage GoogleCloudStorageConnectionTechnologyTypeEnum = "GOOGLE_CLOUD_STORAGE"
)
func GetGoogleCloudStorageConnectionTechnologyTypeEnumValues() []GoogleCloudStorageConnectionTechnologyTypeEnum
GetGoogleCloudStorageConnectionTechnologyTypeEnumValues Enumerates the set of values for GoogleCloudStorageConnectionTechnologyTypeEnum
func GetMappingGoogleCloudStorageConnectionTechnologyTypeEnum(val string) (GoogleCloudStorageConnectionTechnologyTypeEnum, bool)
GetMappingGoogleCloudStorageConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GooglePubSubConnection Represents the metadata of a Google PubSub Connection.
type GooglePubSubConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google PubSub.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// The Google PubSub technology type.
TechnologyType GooglePubSubConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m GooglePubSubConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GooglePubSubConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GooglePubSubConnection) GetDescription() *string
GetDescription returns Description
func (m GooglePubSubConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GooglePubSubConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GooglePubSubConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GooglePubSubConnection) GetId() *string
GetId returns Id
func (m GooglePubSubConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GooglePubSubConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m GooglePubSubConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GooglePubSubConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GooglePubSubConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GooglePubSubConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GooglePubSubConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GooglePubSubConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GooglePubSubConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GooglePubSubConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GooglePubSubConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GooglePubSubConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m GooglePubSubConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GooglePubSubConnection) String() string
func (m GooglePubSubConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GooglePubSubConnectionSummary Summary of the Google PubSub Connection.
type GooglePubSubConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google PubSub.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Google PubSub technology type.
TechnologyType GooglePubSubConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m GooglePubSubConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m GooglePubSubConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m GooglePubSubConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m GooglePubSubConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m GooglePubSubConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m GooglePubSubConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m GooglePubSubConnectionSummary) GetId() *string
GetId returns Id
func (m GooglePubSubConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m GooglePubSubConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m GooglePubSubConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m GooglePubSubConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m GooglePubSubConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m GooglePubSubConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m GooglePubSubConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m GooglePubSubConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m GooglePubSubConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m GooglePubSubConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GooglePubSubConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m GooglePubSubConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m GooglePubSubConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GooglePubSubConnectionSummary) String() string
func (m GooglePubSubConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GooglePubSubConnectionTechnologyTypeEnum Enum with underlying type: string
type GooglePubSubConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for GooglePubSubConnectionTechnologyTypeEnum
const (
GooglePubSubConnectionTechnologyTypeGooglePubsub GooglePubSubConnectionTechnologyTypeEnum = "GOOGLE_PUBSUB"
)
func GetGooglePubSubConnectionTechnologyTypeEnumValues() []GooglePubSubConnectionTechnologyTypeEnum
GetGooglePubSubConnectionTechnologyTypeEnumValues Enumerates the set of values for GooglePubSubConnectionTechnologyTypeEnum
func GetMappingGooglePubSubConnectionTechnologyTypeEnum(val string) (GooglePubSubConnectionTechnologyTypeEnum, bool)
GetMappingGooglePubSubConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GroupToRolesMappingDetails Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
type GroupToRolesMappingDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup.
// It grants administration of security related objects and invoke security related service requests. This role has full privileges.
SecurityGroupId *string `mandatory:"true" json:"securityGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup.
// It grants full access to the user, including the ability to alter general, non-security related operational parameters
// and profiles of the server.
AdministratorGroupId *string `mandatory:"false" json:"administratorGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup.
// It allows users to perform only operational actions, like starting and stopping resources.
// Operators cannot alter the operational parameters or profiles of the MA server.
OperatorGroupId *string `mandatory:"false" json:"operatorGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup.
// It allows information-only service requests, which do not alter or affect the operation of either the MA.
// Examples of query and read-only information include performance metric information and resource status and monitoring information
UserGroupId *string `mandatory:"false" json:"userGroupId"`
}
func (m GroupToRolesMappingDetails) String() string
func (m GroupToRolesMappingDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HdfsConnection Represents the metadata of a Hadoop Distributed File System Connection.
type HdfsConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The Hadoop Distributed File System technology type.
TechnologyType HdfsConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m HdfsConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m HdfsConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m HdfsConnection) GetDescription() *string
GetDescription returns Description
func (m HdfsConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m HdfsConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m HdfsConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m HdfsConnection) GetId() *string
GetId returns Id
func (m HdfsConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m HdfsConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m HdfsConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m HdfsConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m HdfsConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m HdfsConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m HdfsConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m HdfsConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m HdfsConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m HdfsConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m HdfsConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m HdfsConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m HdfsConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m HdfsConnection) String() string
func (m HdfsConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HdfsConnectionSummary Summary of the Hadoop Distributed File System Connection.
type HdfsConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Hadoop Distributed File System technology type.
TechnologyType HdfsConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m HdfsConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m HdfsConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m HdfsConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m HdfsConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m HdfsConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m HdfsConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m HdfsConnectionSummary) GetId() *string
GetId returns Id
func (m HdfsConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m HdfsConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m HdfsConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m HdfsConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m HdfsConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m HdfsConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m HdfsConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m HdfsConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m HdfsConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m HdfsConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m HdfsConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m HdfsConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m HdfsConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m HdfsConnectionSummary) String() string
func (m HdfsConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HdfsConnectionTechnologyTypeEnum Enum with underlying type: string
type HdfsConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for HdfsConnectionTechnologyTypeEnum
const (
HdfsConnectionTechnologyTypeHdfs HdfsConnectionTechnologyTypeEnum = "HDFS"
)
func GetHdfsConnectionTechnologyTypeEnumValues() []HdfsConnectionTechnologyTypeEnum
GetHdfsConnectionTechnologyTypeEnumValues Enumerates the set of values for HdfsConnectionTechnologyTypeEnum
func GetMappingHdfsConnectionTechnologyTypeEnum(val string) (HdfsConnectionTechnologyTypeEnum, bool)
GetMappingHdfsConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ImportDeploymentWalletDetails Metadata required to import wallet to deployment
type ImportDeploymentWalletDetails struct {
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"true" json:"vaultId"`
// The OCID of the customer's GoldenGate Service Secret.
// If provided, it references a key that customers will be required to ensure the policies are established
// to permit GoldenGate to use this Secret.
NewWalletSecretId *string `mandatory:"true" json:"newWalletSecretId"`
// Name of the secret with which secret is shown in vault
WalletBackupSecretName *string `mandatory:"false" json:"walletBackupSecretName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment, where the secret will be created in.
WalletBackupSecretCompartmentId *string `mandatory:"false" json:"walletBackupSecretCompartmentId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
MasterEncryptionKeyId *string `mandatory:"false" json:"masterEncryptionKeyId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
}
func (m ImportDeploymentWalletDetails) String() string
func (m ImportDeploymentWalletDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportDeploymentWalletRequest wrapper for the ImportDeploymentWallet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ImportDeploymentWallet.go.html to see an example of how to use ImportDeploymentWalletRequest.
type ImportDeploymentWalletRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// Metadata to import wallet to deployment. This also includes the OCI Vault information where the wallet will be imported from
ImportDeploymentWalletDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ImportDeploymentWalletRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportDeploymentWalletRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportDeploymentWalletRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportDeploymentWalletRequest) String() string
func (request ImportDeploymentWalletRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportDeploymentWalletResponse wrapper for the ImportDeploymentWallet operation
type ImportDeploymentWalletResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ImportDeploymentWalletResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportDeploymentWalletResponse) String() string
IngressIpDetails Private Endpoint IP Addresses created in the customer's subnet. GoldenGate service will use these ingress IP addresses to send all specific requests initiated from the service. These are typically used for accessing customer resources.
type IngressIpDetails struct {
// A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
IngressIp *string `mandatory:"true" json:"ingressIp"`
}
func (m IngressIpDetails) String() string
func (m IngressIpDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InitialDataLoad Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
type InitialDataLoad struct {
// If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.
IsInitialLoad InitialDataLoadIsInitialLoadEnum `mandatory:"true" json:"isInitialLoad"`
// Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
ActionOnExistingTable InitialLoadActionEnum `mandatory:"false" json:"actionOnExistingTable,omitempty"`
}
func (m InitialDataLoad) String() string
func (m InitialDataLoad) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InitialDataLoadIsInitialLoadEnum Enum with underlying type: string
type InitialDataLoadIsInitialLoadEnum string
Set of constants representing the allowable values for InitialDataLoadIsInitialLoadEnum
const (
InitialDataLoadIsInitialLoadEnabled InitialDataLoadIsInitialLoadEnum = "ENABLED"
InitialDataLoadIsInitialLoadDisabled InitialDataLoadIsInitialLoadEnum = "DISABLED"
)
func GetInitialDataLoadIsInitialLoadEnumValues() []InitialDataLoadIsInitialLoadEnum
GetInitialDataLoadIsInitialLoadEnumValues Enumerates the set of values for InitialDataLoadIsInitialLoadEnum
func GetMappingInitialDataLoadIsInitialLoadEnum(val string) (InitialDataLoadIsInitialLoadEnum, bool)
GetMappingInitialDataLoadIsInitialLoadEnum performs case Insensitive comparison on enum value and return the desired enum
InitialLoadActionEnum Enum with underlying type: string
type InitialLoadActionEnum string
Set of constants representing the allowable values for InitialLoadActionEnum
const (
InitialLoadActionTruncate InitialLoadActionEnum = "TRUNCATE"
InitialLoadActionReplace InitialLoadActionEnum = "REPLACE"
InitialLoadActionAppend InitialLoadActionEnum = "APPEND"
InitialLoadActionSkip InitialLoadActionEnum = "SKIP"
)
func GetInitialLoadActionEnumValues() []InitialLoadActionEnum
GetInitialLoadActionEnumValues Enumerates the set of values for InitialLoadActionEnum
func GetMappingInitialLoadActionEnum(val string) (InitialLoadActionEnum, bool)
GetMappingInitialLoadActionEnum performs case Insensitive comparison on enum value and return the desired enum
JavaMessageServiceConnection Represents the metadata of a Java Message Service Connection.
type JavaMessageServiceConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
ShouldUseJndi *bool `mandatory:"true" json:"shouldUseJndi"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The Connection Factory can be looked up using this name.
// e.g.: 'ConnectionFactory'
JndiConnectionFactory *string `mandatory:"false" json:"jndiConnectionFactory"`
// The URL that Java Message Service will use to contact the JNDI provider.
// e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
JndiProviderUrl *string `mandatory:"false" json:"jndiProviderUrl"`
// The implementation of javax.naming.spi.InitialContextFactory interface
// that the client uses to obtain initial naming context.
// e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
JndiInitialContextFactory *string `mandatory:"false" json:"jndiInitialContextFactory"`
// Specifies the identity of the principal (user) to be authenticated.
// e.g.: 'admin2'
JndiSecurityPrincipal *string `mandatory:"false" json:"jndiSecurityPrincipal"`
// Connectin URL of the Java Message Service, specifying the protocol, host, and port.
// e.g.: 'mq://myjms.host.domain:7676'
ConnectionUrl *string `mandatory:"false" json:"connectionUrl"`
// The of Java class implementing javax.jms.ConnectionFactory interface
// supplied by the Java Message Service provider.
// e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
ConnectionFactory *string `mandatory:"false" json:"connectionFactory"`
// The username Oracle GoldenGate uses to connect to the Java Message Service.
// This username must already exist and be available by the Java Message Service to be connected to.
Username *string `mandatory:"false" json:"username"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal.
// Note: When provided, 'jndiSecurityCredentials' field must not be provided.
JndiSecurityCredentialsSecretId *string `mandatory:"false" json:"jndiSecurityCredentialsSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated Java Message Service.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored for the cert inside of the Keystore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// The Java Message Service technology type.
TechnologyType JavaMessageServiceConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Java Message Service. If not provided, default is PLAIN.
// Optional until 2024-06-27, in the release after it will be made required.
SecurityProtocol JavaMessageServiceConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Authentication type for Java Message Service. If not provided, default is NONE.
// Optional until 2024-06-27, in the release after it will be made required.
AuthenticationType JavaMessageServiceConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m JavaMessageServiceConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m JavaMessageServiceConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m JavaMessageServiceConnection) GetDescription() *string
GetDescription returns Description
func (m JavaMessageServiceConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m JavaMessageServiceConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m JavaMessageServiceConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m JavaMessageServiceConnection) GetId() *string
GetId returns Id
func (m JavaMessageServiceConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m JavaMessageServiceConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m JavaMessageServiceConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m JavaMessageServiceConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m JavaMessageServiceConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m JavaMessageServiceConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m JavaMessageServiceConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m JavaMessageServiceConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m JavaMessageServiceConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m JavaMessageServiceConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m JavaMessageServiceConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m JavaMessageServiceConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m JavaMessageServiceConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m JavaMessageServiceConnection) String() string
func (m JavaMessageServiceConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JavaMessageServiceConnectionAuthenticationTypeEnum Enum with underlying type: string
type JavaMessageServiceConnectionAuthenticationTypeEnum string
Set of constants representing the allowable values for JavaMessageServiceConnectionAuthenticationTypeEnum
const (
JavaMessageServiceConnectionAuthenticationTypeNone JavaMessageServiceConnectionAuthenticationTypeEnum = "NONE"
JavaMessageServiceConnectionAuthenticationTypeBasic JavaMessageServiceConnectionAuthenticationTypeEnum = "BASIC"
)
func GetJavaMessageServiceConnectionAuthenticationTypeEnumValues() []JavaMessageServiceConnectionAuthenticationTypeEnum
GetJavaMessageServiceConnectionAuthenticationTypeEnumValues Enumerates the set of values for JavaMessageServiceConnectionAuthenticationTypeEnum
func GetMappingJavaMessageServiceConnectionAuthenticationTypeEnum(val string) (JavaMessageServiceConnectionAuthenticationTypeEnum, bool)
GetMappingJavaMessageServiceConnectionAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
JavaMessageServiceConnectionSecurityProtocolEnum Enum with underlying type: string
type JavaMessageServiceConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for JavaMessageServiceConnectionSecurityProtocolEnum
const (
JavaMessageServiceConnectionSecurityProtocolPlain JavaMessageServiceConnectionSecurityProtocolEnum = "PLAIN"
JavaMessageServiceConnectionSecurityProtocolTls JavaMessageServiceConnectionSecurityProtocolEnum = "TLS"
JavaMessageServiceConnectionSecurityProtocolMtls JavaMessageServiceConnectionSecurityProtocolEnum = "MTLS"
)
func GetJavaMessageServiceConnectionSecurityProtocolEnumValues() []JavaMessageServiceConnectionSecurityProtocolEnum
GetJavaMessageServiceConnectionSecurityProtocolEnumValues Enumerates the set of values for JavaMessageServiceConnectionSecurityProtocolEnum
func GetMappingJavaMessageServiceConnectionSecurityProtocolEnum(val string) (JavaMessageServiceConnectionSecurityProtocolEnum, bool)
GetMappingJavaMessageServiceConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
JavaMessageServiceConnectionSummary Summary of the Java Message Service Connection.
type JavaMessageServiceConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
ShouldUseJndi *bool `mandatory:"true" json:"shouldUseJndi"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The Connection Factory can be looked up using this name.
// e.g.: 'ConnectionFactory'
JndiConnectionFactory *string `mandatory:"false" json:"jndiConnectionFactory"`
// The URL that Java Message Service will use to contact the JNDI provider.
// e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
JndiProviderUrl *string `mandatory:"false" json:"jndiProviderUrl"`
// The implementation of javax.naming.spi.InitialContextFactory interface
// that the client uses to obtain initial naming context.
// e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
JndiInitialContextFactory *string `mandatory:"false" json:"jndiInitialContextFactory"`
// Specifies the identity of the principal (user) to be authenticated.
// e.g.: 'admin2'
JndiSecurityPrincipal *string `mandatory:"false" json:"jndiSecurityPrincipal"`
// Connectin URL of the Java Message Service, specifying the protocol, host, and port.
// e.g.: 'mq://myjms.host.domain:7676'
ConnectionUrl *string `mandatory:"false" json:"connectionUrl"`
// The of Java class implementing javax.jms.ConnectionFactory interface
// supplied by the Java Message Service provider.
// e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
ConnectionFactory *string `mandatory:"false" json:"connectionFactory"`
// The username Oracle GoldenGate uses to connect to the Java Message Service.
// This username must already exist and be available by the Java Message Service to be connected to.
Username *string `mandatory:"false" json:"username"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal.
// Note: When provided, 'jndiSecurityCredentials' field must not be provided.
JndiSecurityCredentialsSecretId *string `mandatory:"false" json:"jndiSecurityCredentialsSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated Java Message Service.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored for the cert inside of the Keystore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Java Message Service technology type.
TechnologyType JavaMessageServiceConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Java Message Service. If not provided, default is PLAIN.
// Optional until 2024-06-27, in the release after it will be made required.
SecurityProtocol JavaMessageServiceConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Authentication type for Java Message Service. If not provided, default is NONE.
// Optional until 2024-06-27, in the release after it will be made required.
AuthenticationType JavaMessageServiceConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m JavaMessageServiceConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m JavaMessageServiceConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m JavaMessageServiceConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m JavaMessageServiceConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m JavaMessageServiceConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m JavaMessageServiceConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m JavaMessageServiceConnectionSummary) GetId() *string
GetId returns Id
func (m JavaMessageServiceConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m JavaMessageServiceConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m JavaMessageServiceConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m JavaMessageServiceConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m JavaMessageServiceConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m JavaMessageServiceConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m JavaMessageServiceConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m JavaMessageServiceConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m JavaMessageServiceConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m JavaMessageServiceConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m JavaMessageServiceConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m JavaMessageServiceConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m JavaMessageServiceConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m JavaMessageServiceConnectionSummary) String() string
func (m JavaMessageServiceConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JavaMessageServiceConnectionTechnologyTypeEnum Enum with underlying type: string
type JavaMessageServiceConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for JavaMessageServiceConnectionTechnologyTypeEnum
const (
JavaMessageServiceConnectionTechnologyTypeOracleWeblogicJms JavaMessageServiceConnectionTechnologyTypeEnum = "ORACLE_WEBLOGIC_JMS"
)
func GetJavaMessageServiceConnectionTechnologyTypeEnumValues() []JavaMessageServiceConnectionTechnologyTypeEnum
GetJavaMessageServiceConnectionTechnologyTypeEnumValues Enumerates the set of values for JavaMessageServiceConnectionTechnologyTypeEnum
func GetMappingJavaMessageServiceConnectionTechnologyTypeEnum(val string) (JavaMessageServiceConnectionTechnologyTypeEnum, bool)
GetMappingJavaMessageServiceConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaBootstrapServer Represents a Kafka bootstrap server with host name, optional port defaults to 9092, and an optional private ip.
type KafkaBootstrapServer struct {
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
}
func (m KafkaBootstrapServer) String() string
func (m KafkaBootstrapServer) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KafkaConnection Represents the metadata of a Kafka Connection.
type KafkaConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced.
StreamPoolId *string `mandatory:"false" json:"streamPoolId"`
// Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka:
// list of KafkaBootstrapServer objects specified by host/port.
// Used for establishing the initial connection to the Kafka cluster.
// Example: `"server1.example.com:9092,server2.example.com:9092"`
BootstrapServers []KafkaBootstrapServer `mandatory:"false" json:"bootstrapServers"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// The base64 encoded content of the consumer.properties file.
ConsumerProperties *string `mandatory:"false" json:"consumerProperties"`
// The base64 encoded content of the producer.properties file.
ProducerProperties *string `mandatory:"false" json:"producerProperties"`
// The Kafka technology type.
TechnologyType KafkaConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Kafka security protocol.
SecurityProtocol KafkaConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m KafkaConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m KafkaConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m KafkaConnection) GetDescription() *string
GetDescription returns Description
func (m KafkaConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m KafkaConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m KafkaConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m KafkaConnection) GetId() *string
GetId returns Id
func (m KafkaConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m KafkaConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m KafkaConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m KafkaConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m KafkaConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m KafkaConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m KafkaConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m KafkaConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m KafkaConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m KafkaConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m KafkaConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m KafkaConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m KafkaConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KafkaConnection) String() string
func (m KafkaConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KafkaConnectionSecurityProtocolEnum Enum with underlying type: string
type KafkaConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for KafkaConnectionSecurityProtocolEnum
const (
KafkaConnectionSecurityProtocolSsl KafkaConnectionSecurityProtocolEnum = "SSL"
KafkaConnectionSecurityProtocolSaslSsl KafkaConnectionSecurityProtocolEnum = "SASL_SSL"
KafkaConnectionSecurityProtocolPlaintext KafkaConnectionSecurityProtocolEnum = "PLAINTEXT"
KafkaConnectionSecurityProtocolSaslPlaintext KafkaConnectionSecurityProtocolEnum = "SASL_PLAINTEXT"
)
func GetKafkaConnectionSecurityProtocolEnumValues() []KafkaConnectionSecurityProtocolEnum
GetKafkaConnectionSecurityProtocolEnumValues Enumerates the set of values for KafkaConnectionSecurityProtocolEnum
func GetMappingKafkaConnectionSecurityProtocolEnum(val string) (KafkaConnectionSecurityProtocolEnum, bool)
GetMappingKafkaConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaConnectionSummary Summary of the Kafka Connection.
type KafkaConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced.
StreamPoolId *string `mandatory:"false" json:"streamPoolId"`
// Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka:
// list of KafkaBootstrapServer objects specified by host/port.
// Used for establishing the initial connection to the Kafka cluster.
// Example: `"server1.example.com:9092,server2.example.com:9092"`
BootstrapServers []KafkaBootstrapServer `mandatory:"false" json:"bootstrapServers"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Kafka technology type.
TechnologyType KafkaConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for Kafka.
SecurityProtocol KafkaConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m KafkaConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m KafkaConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m KafkaConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m KafkaConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m KafkaConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m KafkaConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m KafkaConnectionSummary) GetId() *string
GetId returns Id
func (m KafkaConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m KafkaConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m KafkaConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m KafkaConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m KafkaConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m KafkaConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m KafkaConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m KafkaConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m KafkaConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m KafkaConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m KafkaConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m KafkaConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m KafkaConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KafkaConnectionSummary) String() string
func (m KafkaConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KafkaConnectionTechnologyTypeEnum Enum with underlying type: string
type KafkaConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for KafkaConnectionTechnologyTypeEnum
const (
KafkaConnectionTechnologyTypeApacheKafka KafkaConnectionTechnologyTypeEnum = "APACHE_KAFKA"
KafkaConnectionTechnologyTypeAzureEventHubs KafkaConnectionTechnologyTypeEnum = "AZURE_EVENT_HUBS"
KafkaConnectionTechnologyTypeConfluentKafka KafkaConnectionTechnologyTypeEnum = "CONFLUENT_KAFKA"
KafkaConnectionTechnologyTypeOciStreaming KafkaConnectionTechnologyTypeEnum = "OCI_STREAMING"
)
func GetKafkaConnectionTechnologyTypeEnumValues() []KafkaConnectionTechnologyTypeEnum
GetKafkaConnectionTechnologyTypeEnumValues Enumerates the set of values for KafkaConnectionTechnologyTypeEnum
func GetMappingKafkaConnectionTechnologyTypeEnum(val string) (KafkaConnectionTechnologyTypeEnum, bool)
GetMappingKafkaConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaSchemaRegistryConnection Represents the metadata of a Kafka (e.g. Confluent) Schema Registry Connection.
type KafkaSchemaRegistryConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Kafka Schema Registry URL.
// e.g.: 'https://server1.us.oracle.com:8081'
Url *string `mandatory:"true" json:"url"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
Username *string `mandatory:"false" json:"username"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Kafka Schema Registry password is stored,
// The password to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the cert inside the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// The Kafka (e.g. Confluent) Schema Registry technology type.
TechnologyType KafkaSchemaRegistryConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Schema Registry.
AuthenticationType KafkaSchemaRegistryConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m KafkaSchemaRegistryConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m KafkaSchemaRegistryConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m KafkaSchemaRegistryConnection) GetDescription() *string
GetDescription returns Description
func (m KafkaSchemaRegistryConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m KafkaSchemaRegistryConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m KafkaSchemaRegistryConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m KafkaSchemaRegistryConnection) GetId() *string
GetId returns Id
func (m KafkaSchemaRegistryConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m KafkaSchemaRegistryConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m KafkaSchemaRegistryConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m KafkaSchemaRegistryConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m KafkaSchemaRegistryConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m KafkaSchemaRegistryConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m KafkaSchemaRegistryConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m KafkaSchemaRegistryConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m KafkaSchemaRegistryConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m KafkaSchemaRegistryConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m KafkaSchemaRegistryConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m KafkaSchemaRegistryConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m KafkaSchemaRegistryConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KafkaSchemaRegistryConnection) String() string
func (m KafkaSchemaRegistryConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KafkaSchemaRegistryConnectionAuthenticationTypeEnum Enum with underlying type: string
type KafkaSchemaRegistryConnectionAuthenticationTypeEnum string
Set of constants representing the allowable values for KafkaSchemaRegistryConnectionAuthenticationTypeEnum
const (
KafkaSchemaRegistryConnectionAuthenticationTypeNone KafkaSchemaRegistryConnectionAuthenticationTypeEnum = "NONE"
KafkaSchemaRegistryConnectionAuthenticationTypeBasic KafkaSchemaRegistryConnectionAuthenticationTypeEnum = "BASIC"
KafkaSchemaRegistryConnectionAuthenticationTypeMutual KafkaSchemaRegistryConnectionAuthenticationTypeEnum = "MUTUAL"
)
func GetKafkaSchemaRegistryConnectionAuthenticationTypeEnumValues() []KafkaSchemaRegistryConnectionAuthenticationTypeEnum
GetKafkaSchemaRegistryConnectionAuthenticationTypeEnumValues Enumerates the set of values for KafkaSchemaRegistryConnectionAuthenticationTypeEnum
func GetMappingKafkaSchemaRegistryConnectionAuthenticationTypeEnum(val string) (KafkaSchemaRegistryConnectionAuthenticationTypeEnum, bool)
GetMappingKafkaSchemaRegistryConnectionAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
KafkaSchemaRegistryConnectionSummary Summary of the Kafka (e.g. Confluent) Schema Registry Connection.
type KafkaSchemaRegistryConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Kafka Schema Registry URL.
// e.g.: 'https://server1.us.oracle.com:8081'
Url *string `mandatory:"true" json:"url"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
Username *string `mandatory:"false" json:"username"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Kafka Schema Registry password is stored,
// The password to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the cert inside the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Kafka (e.g. Confluent) Schema Registry technology type.
TechnologyType KafkaSchemaRegistryConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Schema Registry.
AuthenticationType KafkaSchemaRegistryConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m KafkaSchemaRegistryConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m KafkaSchemaRegistryConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m KafkaSchemaRegistryConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m KafkaSchemaRegistryConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m KafkaSchemaRegistryConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m KafkaSchemaRegistryConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m KafkaSchemaRegistryConnectionSummary) GetId() *string
GetId returns Id
func (m KafkaSchemaRegistryConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m KafkaSchemaRegistryConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m KafkaSchemaRegistryConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m KafkaSchemaRegistryConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m KafkaSchemaRegistryConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m KafkaSchemaRegistryConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m KafkaSchemaRegistryConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m KafkaSchemaRegistryConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m KafkaSchemaRegistryConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m KafkaSchemaRegistryConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m KafkaSchemaRegistryConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m KafkaSchemaRegistryConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m KafkaSchemaRegistryConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KafkaSchemaRegistryConnectionSummary) String() string
func (m KafkaSchemaRegistryConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KafkaSchemaRegistryConnectionTechnologyTypeEnum Enum with underlying type: string
type KafkaSchemaRegistryConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for KafkaSchemaRegistryConnectionTechnologyTypeEnum
const (
KafkaSchemaRegistryConnectionTechnologyTypeConfluentSchemaRegistry KafkaSchemaRegistryConnectionTechnologyTypeEnum = "CONFLUENT_SCHEMA_REGISTRY"
)
func GetKafkaSchemaRegistryConnectionTechnologyTypeEnumValues() []KafkaSchemaRegistryConnectionTechnologyTypeEnum
GetKafkaSchemaRegistryConnectionTechnologyTypeEnumValues Enumerates the set of values for KafkaSchemaRegistryConnectionTechnologyTypeEnum
func GetMappingKafkaSchemaRegistryConnectionTechnologyTypeEnum(val string) (KafkaSchemaRegistryConnectionTechnologyTypeEnum, bool)
GetMappingKafkaSchemaRegistryConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
LibraryTypeEnum Enum with underlying type: string
type LibraryTypeEnum string
Set of constants representing the allowable values for LibraryTypeEnum
const (
LibraryTypeLogReaderComponent LibraryTypeEnum = "LOG_READER_COMPONENT"
)
func GetLibraryTypeEnumValues() []LibraryTypeEnum
GetLibraryTypeEnumValues Enumerates the set of values for LibraryTypeEnum
func GetMappingLibraryTypeEnum(val string) (LibraryTypeEnum, bool)
GetMappingLibraryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
LibraryUrl A Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.
type LibraryUrl struct {
// The URL of a resource.
Url *string `mandatory:"true" json:"url"`
}
func (m LibraryUrl) String() string
func (m LibraryUrl) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LicenseModelEnum Enum with underlying type: string
type LicenseModelEnum string
Set of constants representing the allowable values for LicenseModelEnum
const (
LicenseModelLicenseIncluded LicenseModelEnum = "LICENSE_INCLUDED"
LicenseModelBringYourOwnLicense LicenseModelEnum = "BRING_YOUR_OWN_LICENSE"
)
func GetLicenseModelEnumValues() []LicenseModelEnum
GetLicenseModelEnumValues Enumerates the set of values for LicenseModelEnum
func GetMappingLicenseModelEnum(val string) (LicenseModelEnum, bool)
GetMappingLicenseModelEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
LifecycleStateNeedsAttention LifecycleStateEnum = "NEEDS_ATTENTION"
LifecycleStateInProgress LifecycleStateEnum = "IN_PROGRESS"
LifecycleStateCanceling LifecycleStateEnum = "CANCELING"
LifecycleStateCanceled LifecycleStateEnum = "CANCELED"
LifecycleStateSucceeded LifecycleStateEnum = "SUCCEEDED"
LifecycleStateWaiting LifecycleStateEnum = "WAITING"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleSubStateEnum Enum with underlying type: string
type LifecycleSubStateEnum string
Set of constants representing the allowable values for LifecycleSubStateEnum
const (
LifecycleSubStateRecovering LifecycleSubStateEnum = "RECOVERING"
LifecycleSubStateStarting LifecycleSubStateEnum = "STARTING"
LifecycleSubStateStopping LifecycleSubStateEnum = "STOPPING"
LifecycleSubStateMoving LifecycleSubStateEnum = "MOVING"
LifecycleSubStateUpgrading LifecycleSubStateEnum = "UPGRADING"
LifecycleSubStateRestoring LifecycleSubStateEnum = "RESTORING"
LifecycleSubStateBackupInProgress LifecycleSubStateEnum = "BACKUP_IN_PROGRESS"
LifecycleSubStateRollbackInProgress LifecycleSubStateEnum = "ROLLBACK_IN_PROGRESS"
)
func GetLifecycleSubStateEnumValues() []LifecycleSubStateEnum
GetLifecycleSubStateEnumValues Enumerates the set of values for LifecycleSubStateEnum
func GetMappingLifecycleSubStateEnum(val string) (LifecycleSubStateEnum, bool)
GetMappingLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListCertificatesLifecycleStateEnum Enum with underlying type: string
type ListCertificatesLifecycleStateEnum string
Set of constants representing the allowable values for ListCertificatesLifecycleStateEnum
const (
ListCertificatesLifecycleStateCreating ListCertificatesLifecycleStateEnum = "CREATING"
ListCertificatesLifecycleStateActive ListCertificatesLifecycleStateEnum = "ACTIVE"
ListCertificatesLifecycleStateDeleting ListCertificatesLifecycleStateEnum = "DELETING"
ListCertificatesLifecycleStateDeleted ListCertificatesLifecycleStateEnum = "DELETED"
ListCertificatesLifecycleStateFailed ListCertificatesLifecycleStateEnum = "FAILED"
)
func GetListCertificatesLifecycleStateEnumValues() []ListCertificatesLifecycleStateEnum
GetListCertificatesLifecycleStateEnumValues Enumerates the set of values for ListCertificatesLifecycleStateEnum
func GetMappingListCertificatesLifecycleStateEnum(val string) (ListCertificatesLifecycleStateEnum, bool)
GetMappingListCertificatesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListCertificatesRequest wrapper for the ListCertificates operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListCertificates.go.html to see an example of how to use ListCertificatesRequest.
type ListCertificatesRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only connections having the 'lifecycleState' given.
LifecycleState ListCertificatesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListCertificatesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListCertificatesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListCertificatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCertificatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCertificatesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCertificatesRequest) String() string
func (request ListCertificatesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCertificatesResponse wrapper for the ListCertificates operation
type ListCertificatesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of CertificateCollection instances
CertificateCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCertificatesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCertificatesResponse) String() string
ListCertificatesSortByEnum Enum with underlying type: string
type ListCertificatesSortByEnum string
Set of constants representing the allowable values for ListCertificatesSortByEnum
const (
ListCertificatesSortByTimecreated ListCertificatesSortByEnum = "timeCreated"
ListCertificatesSortByDisplayname ListCertificatesSortByEnum = "displayName"
)
func GetListCertificatesSortByEnumValues() []ListCertificatesSortByEnum
GetListCertificatesSortByEnumValues Enumerates the set of values for ListCertificatesSortByEnum
func GetMappingListCertificatesSortByEnum(val string) (ListCertificatesSortByEnum, bool)
GetMappingListCertificatesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCertificatesSortOrderEnum Enum with underlying type: string
type ListCertificatesSortOrderEnum string
Set of constants representing the allowable values for ListCertificatesSortOrderEnum
const (
ListCertificatesSortOrderAsc ListCertificatesSortOrderEnum = "ASC"
ListCertificatesSortOrderDesc ListCertificatesSortOrderEnum = "DESC"
)
func GetListCertificatesSortOrderEnumValues() []ListCertificatesSortOrderEnum
GetListCertificatesSortOrderEnumValues Enumerates the set of values for ListCertificatesSortOrderEnum
func GetMappingListCertificatesSortOrderEnum(val string) (ListCertificatesSortOrderEnum, bool)
GetMappingListCertificatesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectionAssignmentsRequest wrapper for the ListConnectionAssignments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListConnectionAssignments.go.html to see an example of how to use ListConnectionAssignmentsRequest.
type ListConnectionAssignmentsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.
DeploymentId *string `mandatory:"false" contributesTo:"query" name:"deploymentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection.
ConnectionId *string `mandatory:"false" contributesTo:"query" name:"connectionId"`
// The name of the connection in the assignment (aliasName).
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only connection assignments having the 'lifecycleState' given.
LifecycleState ConnectionAssignmentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListConnectionAssignmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListConnectionAssignmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListConnectionAssignmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConnectionAssignmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConnectionAssignmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConnectionAssignmentsRequest) String() string
func (request ListConnectionAssignmentsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListConnectionAssignmentsResponse wrapper for the ListConnectionAssignments operation
type ListConnectionAssignmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ConnectionAssignmentCollection instances
ConnectionAssignmentCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListConnectionAssignmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListConnectionAssignmentsResponse) String() string
ListConnectionAssignmentsSortByEnum Enum with underlying type: string
type ListConnectionAssignmentsSortByEnum string
Set of constants representing the allowable values for ListConnectionAssignmentsSortByEnum
const (
ListConnectionAssignmentsSortByTimecreated ListConnectionAssignmentsSortByEnum = "timeCreated"
ListConnectionAssignmentsSortByDisplayname ListConnectionAssignmentsSortByEnum = "displayName"
)
func GetListConnectionAssignmentsSortByEnumValues() []ListConnectionAssignmentsSortByEnum
GetListConnectionAssignmentsSortByEnumValues Enumerates the set of values for ListConnectionAssignmentsSortByEnum
func GetMappingListConnectionAssignmentsSortByEnum(val string) (ListConnectionAssignmentsSortByEnum, bool)
GetMappingListConnectionAssignmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectionAssignmentsSortOrderEnum Enum with underlying type: string
type ListConnectionAssignmentsSortOrderEnum string
Set of constants representing the allowable values for ListConnectionAssignmentsSortOrderEnum
const (
ListConnectionAssignmentsSortOrderAsc ListConnectionAssignmentsSortOrderEnum = "ASC"
ListConnectionAssignmentsSortOrderDesc ListConnectionAssignmentsSortOrderEnum = "DESC"
)
func GetListConnectionAssignmentsSortOrderEnumValues() []ListConnectionAssignmentsSortOrderEnum
GetListConnectionAssignmentsSortOrderEnumValues Enumerates the set of values for ListConnectionAssignmentsSortOrderEnum
func GetMappingListConnectionAssignmentsSortOrderEnum(val string) (ListConnectionAssignmentsSortOrderEnum, bool)
GetMappingListConnectionAssignmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectionsAssignableDeploymentTypeEnum Enum with underlying type: string
type ListConnectionsAssignableDeploymentTypeEnum string
Set of constants representing the allowable values for ListConnectionsAssignableDeploymentTypeEnum
const (
ListConnectionsAssignableDeploymentTypeOgg ListConnectionsAssignableDeploymentTypeEnum = "OGG"
ListConnectionsAssignableDeploymentTypeDatabaseOracle ListConnectionsAssignableDeploymentTypeEnum = "DATABASE_ORACLE"
ListConnectionsAssignableDeploymentTypeBigdata ListConnectionsAssignableDeploymentTypeEnum = "BIGDATA"
ListConnectionsAssignableDeploymentTypeDatabaseMicrosoftSqlserver ListConnectionsAssignableDeploymentTypeEnum = "DATABASE_MICROSOFT_SQLSERVER"
ListConnectionsAssignableDeploymentTypeDatabaseMysql ListConnectionsAssignableDeploymentTypeEnum = "DATABASE_MYSQL"
ListConnectionsAssignableDeploymentTypeDatabasePostgresql ListConnectionsAssignableDeploymentTypeEnum = "DATABASE_POSTGRESQL"
ListConnectionsAssignableDeploymentTypeDatabaseDb2zos ListConnectionsAssignableDeploymentTypeEnum = "DATABASE_DB2ZOS"
ListConnectionsAssignableDeploymentTypeGgsa ListConnectionsAssignableDeploymentTypeEnum = "GGSA"
ListConnectionsAssignableDeploymentTypeDataTransforms ListConnectionsAssignableDeploymentTypeEnum = "DATA_TRANSFORMS"
)
func GetListConnectionsAssignableDeploymentTypeEnumValues() []ListConnectionsAssignableDeploymentTypeEnum
GetListConnectionsAssignableDeploymentTypeEnumValues Enumerates the set of values for ListConnectionsAssignableDeploymentTypeEnum
func GetMappingListConnectionsAssignableDeploymentTypeEnum(val string) (ListConnectionsAssignableDeploymentTypeEnum, bool)
GetMappingListConnectionsAssignableDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectionsRequest wrapper for the ListConnections operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListConnections.go.html to see an example of how to use ListConnectionsRequest.
type ListConnectionsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The array of technology types.
TechnologyType []TechnologyTypeEnum `contributesTo:"query" name:"technologyType" omitEmpty:"true" collectionFormat:"multi"`
// The array of connection types.
ConnectionType []ConnectionTypeEnum `contributesTo:"query" name:"connectionType" omitEmpty:"true" collectionFormat:"multi"`
// The OCID of the deployment which for the connection must be assigned.
AssignedDeploymentId *string `mandatory:"false" contributesTo:"query" name:"assignedDeploymentId"`
// Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
AssignableDeploymentId *string `mandatory:"false" contributesTo:"query" name:"assignableDeploymentId"`
// Filters for connections which can be assigned to the latest version of the specified deployment type.
AssignableDeploymentType ListConnectionsAssignableDeploymentTypeEnum `mandatory:"false" contributesTo:"query" name:"assignableDeploymentType" omitEmpty:"true"`
// A filter to return only connections having the 'lifecycleState' given.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListConnectionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListConnectionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListConnectionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConnectionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConnectionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConnectionsRequest) String() string
func (request ListConnectionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListConnectionsResponse wrapper for the ListConnections operation
type ListConnectionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ConnectionCollection instances
ConnectionCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListConnectionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListConnectionsResponse) String() string
ListConnectionsSortByEnum Enum with underlying type: string
type ListConnectionsSortByEnum string
Set of constants representing the allowable values for ListConnectionsSortByEnum
const (
ListConnectionsSortByTimecreated ListConnectionsSortByEnum = "timeCreated"
ListConnectionsSortByDisplayname ListConnectionsSortByEnum = "displayName"
)
func GetListConnectionsSortByEnumValues() []ListConnectionsSortByEnum
GetListConnectionsSortByEnumValues Enumerates the set of values for ListConnectionsSortByEnum
func GetMappingListConnectionsSortByEnum(val string) (ListConnectionsSortByEnum, bool)
GetMappingListConnectionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectionsSortOrderEnum Enum with underlying type: string
type ListConnectionsSortOrderEnum string
Set of constants representing the allowable values for ListConnectionsSortOrderEnum
const (
ListConnectionsSortOrderAsc ListConnectionsSortOrderEnum = "ASC"
ListConnectionsSortOrderDesc ListConnectionsSortOrderEnum = "DESC"
)
func GetListConnectionsSortOrderEnumValues() []ListConnectionsSortOrderEnum
GetListConnectionsSortOrderEnumValues Enumerates the set of values for ListConnectionsSortOrderEnum
func GetMappingListConnectionsSortOrderEnum(val string) (ListConnectionsSortOrderEnum, bool)
GetMappingListConnectionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDatabaseRegistrationsLifecycleStateEnum Enum with underlying type: string
type ListDatabaseRegistrationsLifecycleStateEnum string
Set of constants representing the allowable values for ListDatabaseRegistrationsLifecycleStateEnum
const (
ListDatabaseRegistrationsLifecycleStateCreating ListDatabaseRegistrationsLifecycleStateEnum = "CREATING"
ListDatabaseRegistrationsLifecycleStateUpdating ListDatabaseRegistrationsLifecycleStateEnum = "UPDATING"
ListDatabaseRegistrationsLifecycleStateActive ListDatabaseRegistrationsLifecycleStateEnum = "ACTIVE"
ListDatabaseRegistrationsLifecycleStateInactive ListDatabaseRegistrationsLifecycleStateEnum = "INACTIVE"
ListDatabaseRegistrationsLifecycleStateDeleting ListDatabaseRegistrationsLifecycleStateEnum = "DELETING"
ListDatabaseRegistrationsLifecycleStateDeleted ListDatabaseRegistrationsLifecycleStateEnum = "DELETED"
ListDatabaseRegistrationsLifecycleStateFailed ListDatabaseRegistrationsLifecycleStateEnum = "FAILED"
ListDatabaseRegistrationsLifecycleStateNeedsAttention ListDatabaseRegistrationsLifecycleStateEnum = "NEEDS_ATTENTION"
ListDatabaseRegistrationsLifecycleStateInProgress ListDatabaseRegistrationsLifecycleStateEnum = "IN_PROGRESS"
ListDatabaseRegistrationsLifecycleStateCanceling ListDatabaseRegistrationsLifecycleStateEnum = "CANCELING"
ListDatabaseRegistrationsLifecycleStateCanceled ListDatabaseRegistrationsLifecycleStateEnum = "CANCELED"
ListDatabaseRegistrationsLifecycleStateSucceeded ListDatabaseRegistrationsLifecycleStateEnum = "SUCCEEDED"
ListDatabaseRegistrationsLifecycleStateWaiting ListDatabaseRegistrationsLifecycleStateEnum = "WAITING"
)
func GetListDatabaseRegistrationsLifecycleStateEnumValues() []ListDatabaseRegistrationsLifecycleStateEnum
GetListDatabaseRegistrationsLifecycleStateEnumValues Enumerates the set of values for ListDatabaseRegistrationsLifecycleStateEnum
func GetMappingListDatabaseRegistrationsLifecycleStateEnum(val string) (ListDatabaseRegistrationsLifecycleStateEnum, bool)
GetMappingListDatabaseRegistrationsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDatabaseRegistrationsRequest wrapper for the ListDatabaseRegistrations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDatabaseRegistrations.go.html to see an example of how to use ListDatabaseRegistrationsRequest.
type ListDatabaseRegistrationsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only the resources that match the 'lifecycleState' given.
LifecycleState ListDatabaseRegistrationsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDatabaseRegistrationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListDatabaseRegistrationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDatabaseRegistrationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDatabaseRegistrationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDatabaseRegistrationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDatabaseRegistrationsRequest) String() string
func (request ListDatabaseRegistrationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDatabaseRegistrationsResponse wrapper for the ListDatabaseRegistrations operation
type ListDatabaseRegistrationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DatabaseRegistrationCollection instances
DatabaseRegistrationCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Deprecation date of this API version.
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response ListDatabaseRegistrationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDatabaseRegistrationsResponse) String() string
ListDatabaseRegistrationsSortByEnum Enum with underlying type: string
type ListDatabaseRegistrationsSortByEnum string
Set of constants representing the allowable values for ListDatabaseRegistrationsSortByEnum
const (
ListDatabaseRegistrationsSortByTimecreated ListDatabaseRegistrationsSortByEnum = "timeCreated"
ListDatabaseRegistrationsSortByDisplayname ListDatabaseRegistrationsSortByEnum = "displayName"
)
func GetListDatabaseRegistrationsSortByEnumValues() []ListDatabaseRegistrationsSortByEnum
GetListDatabaseRegistrationsSortByEnumValues Enumerates the set of values for ListDatabaseRegistrationsSortByEnum
func GetMappingListDatabaseRegistrationsSortByEnum(val string) (ListDatabaseRegistrationsSortByEnum, bool)
GetMappingListDatabaseRegistrationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDatabaseRegistrationsSortOrderEnum Enum with underlying type: string
type ListDatabaseRegistrationsSortOrderEnum string
Set of constants representing the allowable values for ListDatabaseRegistrationsSortOrderEnum
const (
ListDatabaseRegistrationsSortOrderAsc ListDatabaseRegistrationsSortOrderEnum = "ASC"
ListDatabaseRegistrationsSortOrderDesc ListDatabaseRegistrationsSortOrderEnum = "DESC"
)
func GetListDatabaseRegistrationsSortOrderEnumValues() []ListDatabaseRegistrationsSortOrderEnum
GetListDatabaseRegistrationsSortOrderEnumValues Enumerates the set of values for ListDatabaseRegistrationsSortOrderEnum
func GetMappingListDatabaseRegistrationsSortOrderEnum(val string) (ListDatabaseRegistrationsSortOrderEnum, bool)
GetMappingListDatabaseRegistrationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentBackupsLifecycleStateEnum Enum with underlying type: string
type ListDeploymentBackupsLifecycleStateEnum string
Set of constants representing the allowable values for ListDeploymentBackupsLifecycleStateEnum
const (
ListDeploymentBackupsLifecycleStateCreating ListDeploymentBackupsLifecycleStateEnum = "CREATING"
ListDeploymentBackupsLifecycleStateUpdating ListDeploymentBackupsLifecycleStateEnum = "UPDATING"
ListDeploymentBackupsLifecycleStateActive ListDeploymentBackupsLifecycleStateEnum = "ACTIVE"
ListDeploymentBackupsLifecycleStateInactive ListDeploymentBackupsLifecycleStateEnum = "INACTIVE"
ListDeploymentBackupsLifecycleStateDeleting ListDeploymentBackupsLifecycleStateEnum = "DELETING"
ListDeploymentBackupsLifecycleStateDeleted ListDeploymentBackupsLifecycleStateEnum = "DELETED"
ListDeploymentBackupsLifecycleStateFailed ListDeploymentBackupsLifecycleStateEnum = "FAILED"
ListDeploymentBackupsLifecycleStateNeedsAttention ListDeploymentBackupsLifecycleStateEnum = "NEEDS_ATTENTION"
ListDeploymentBackupsLifecycleStateInProgress ListDeploymentBackupsLifecycleStateEnum = "IN_PROGRESS"
ListDeploymentBackupsLifecycleStateCanceling ListDeploymentBackupsLifecycleStateEnum = "CANCELING"
ListDeploymentBackupsLifecycleStateCanceled ListDeploymentBackupsLifecycleStateEnum = "CANCELED"
ListDeploymentBackupsLifecycleStateSucceeded ListDeploymentBackupsLifecycleStateEnum = "SUCCEEDED"
ListDeploymentBackupsLifecycleStateWaiting ListDeploymentBackupsLifecycleStateEnum = "WAITING"
)
func GetListDeploymentBackupsLifecycleStateEnumValues() []ListDeploymentBackupsLifecycleStateEnum
GetListDeploymentBackupsLifecycleStateEnumValues Enumerates the set of values for ListDeploymentBackupsLifecycleStateEnum
func GetMappingListDeploymentBackupsLifecycleStateEnum(val string) (ListDeploymentBackupsLifecycleStateEnum, bool)
GetMappingListDeploymentBackupsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentBackupsRequest wrapper for the ListDeploymentBackups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentBackups.go.html to see an example of how to use ListDeploymentBackupsRequest.
type ListDeploymentBackupsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.
DeploymentId *string `mandatory:"false" contributesTo:"query" name:"deploymentId"`
// A filter to return only the resources that match the 'lifecycleState' given.
LifecycleState ListDeploymentBackupsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDeploymentBackupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListDeploymentBackupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDeploymentBackupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentBackupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentBackupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentBackupsRequest) String() string
func (request ListDeploymentBackupsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDeploymentBackupsResponse wrapper for the ListDeploymentBackups operation
type ListDeploymentBackupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentBackupCollection instances
DeploymentBackupCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDeploymentBackupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentBackupsResponse) String() string
ListDeploymentBackupsSortByEnum Enum with underlying type: string
type ListDeploymentBackupsSortByEnum string
Set of constants representing the allowable values for ListDeploymentBackupsSortByEnum
const (
ListDeploymentBackupsSortByTimecreated ListDeploymentBackupsSortByEnum = "timeCreated"
ListDeploymentBackupsSortByDisplayname ListDeploymentBackupsSortByEnum = "displayName"
)
func GetListDeploymentBackupsSortByEnumValues() []ListDeploymentBackupsSortByEnum
GetListDeploymentBackupsSortByEnumValues Enumerates the set of values for ListDeploymentBackupsSortByEnum
func GetMappingListDeploymentBackupsSortByEnum(val string) (ListDeploymentBackupsSortByEnum, bool)
GetMappingListDeploymentBackupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentBackupsSortOrderEnum Enum with underlying type: string
type ListDeploymentBackupsSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentBackupsSortOrderEnum
const (
ListDeploymentBackupsSortOrderAsc ListDeploymentBackupsSortOrderEnum = "ASC"
ListDeploymentBackupsSortOrderDesc ListDeploymentBackupsSortOrderEnum = "DESC"
)
func GetListDeploymentBackupsSortOrderEnumValues() []ListDeploymentBackupsSortOrderEnum
GetListDeploymentBackupsSortOrderEnumValues Enumerates the set of values for ListDeploymentBackupsSortOrderEnum
func GetMappingListDeploymentBackupsSortOrderEnum(val string) (ListDeploymentBackupsSortOrderEnum, bool)
GetMappingListDeploymentBackupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentEnvironmentsRequest wrapper for the ListDeploymentEnvironments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentEnvironments.go.html to see an example of how to use ListDeploymentEnvironmentsRequest.
type ListDeploymentEnvironmentsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDeploymentEnvironmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListDeploymentEnvironmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDeploymentEnvironmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentEnvironmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentEnvironmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentEnvironmentsRequest) String() string
func (request ListDeploymentEnvironmentsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDeploymentEnvironmentsResponse wrapper for the ListDeploymentEnvironments operation
type ListDeploymentEnvironmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentEnvironmentCollection instances
DeploymentEnvironmentCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDeploymentEnvironmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentEnvironmentsResponse) String() string
ListDeploymentEnvironmentsSortByEnum Enum with underlying type: string
type ListDeploymentEnvironmentsSortByEnum string
Set of constants representing the allowable values for ListDeploymentEnvironmentsSortByEnum
const (
ListDeploymentEnvironmentsSortByTimecreated ListDeploymentEnvironmentsSortByEnum = "timeCreated"
ListDeploymentEnvironmentsSortByDisplayname ListDeploymentEnvironmentsSortByEnum = "displayName"
)
func GetListDeploymentEnvironmentsSortByEnumValues() []ListDeploymentEnvironmentsSortByEnum
GetListDeploymentEnvironmentsSortByEnumValues Enumerates the set of values for ListDeploymentEnvironmentsSortByEnum
func GetMappingListDeploymentEnvironmentsSortByEnum(val string) (ListDeploymentEnvironmentsSortByEnum, bool)
GetMappingListDeploymentEnvironmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentEnvironmentsSortOrderEnum Enum with underlying type: string
type ListDeploymentEnvironmentsSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentEnvironmentsSortOrderEnum
const (
ListDeploymentEnvironmentsSortOrderAsc ListDeploymentEnvironmentsSortOrderEnum = "ASC"
ListDeploymentEnvironmentsSortOrderDesc ListDeploymentEnvironmentsSortOrderEnum = "DESC"
)
func GetListDeploymentEnvironmentsSortOrderEnumValues() []ListDeploymentEnvironmentsSortOrderEnum
GetListDeploymentEnvironmentsSortOrderEnumValues Enumerates the set of values for ListDeploymentEnvironmentsSortOrderEnum
func GetMappingListDeploymentEnvironmentsSortOrderEnum(val string) (ListDeploymentEnvironmentsSortOrderEnum, bool)
GetMappingListDeploymentEnvironmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentTypesDeploymentTypeEnum Enum with underlying type: string
type ListDeploymentTypesDeploymentTypeEnum string
Set of constants representing the allowable values for ListDeploymentTypesDeploymentTypeEnum
const (
ListDeploymentTypesDeploymentTypeOgg ListDeploymentTypesDeploymentTypeEnum = "OGG"
ListDeploymentTypesDeploymentTypeDatabaseOracle ListDeploymentTypesDeploymentTypeEnum = "DATABASE_ORACLE"
ListDeploymentTypesDeploymentTypeBigdata ListDeploymentTypesDeploymentTypeEnum = "BIGDATA"
ListDeploymentTypesDeploymentTypeDatabaseMicrosoftSqlserver ListDeploymentTypesDeploymentTypeEnum = "DATABASE_MICROSOFT_SQLSERVER"
ListDeploymentTypesDeploymentTypeDatabaseMysql ListDeploymentTypesDeploymentTypeEnum = "DATABASE_MYSQL"
ListDeploymentTypesDeploymentTypeDatabasePostgresql ListDeploymentTypesDeploymentTypeEnum = "DATABASE_POSTGRESQL"
ListDeploymentTypesDeploymentTypeDatabaseDb2zos ListDeploymentTypesDeploymentTypeEnum = "DATABASE_DB2ZOS"
ListDeploymentTypesDeploymentTypeGgsa ListDeploymentTypesDeploymentTypeEnum = "GGSA"
ListDeploymentTypesDeploymentTypeDataTransforms ListDeploymentTypesDeploymentTypeEnum = "DATA_TRANSFORMS"
)
func GetListDeploymentTypesDeploymentTypeEnumValues() []ListDeploymentTypesDeploymentTypeEnum
GetListDeploymentTypesDeploymentTypeEnumValues Enumerates the set of values for ListDeploymentTypesDeploymentTypeEnum
func GetMappingListDeploymentTypesDeploymentTypeEnum(val string) (ListDeploymentTypesDeploymentTypeEnum, bool)
GetMappingListDeploymentTypesDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentTypesRequest wrapper for the ListDeploymentTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentTypes.go.html to see an example of how to use ListDeploymentTypesRequest.
type ListDeploymentTypesRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE.
DeploymentType ListDeploymentTypesDeploymentTypeEnum `mandatory:"false" contributesTo:"query" name:"deploymentType" omitEmpty:"true"`
// Allows to query by a specific GoldenGate version.
OggVersion *string `mandatory:"false" contributesTo:"query" name:"oggVersion"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDeploymentTypesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListDeploymentTypesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDeploymentTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentTypesRequest) String() string
func (request ListDeploymentTypesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDeploymentTypesResponse wrapper for the ListDeploymentTypes operation
type ListDeploymentTypesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentTypeCollection instances
DeploymentTypeCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDeploymentTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentTypesResponse) String() string
ListDeploymentTypesSortByEnum Enum with underlying type: string
type ListDeploymentTypesSortByEnum string
Set of constants representing the allowable values for ListDeploymentTypesSortByEnum
const (
ListDeploymentTypesSortByTimecreated ListDeploymentTypesSortByEnum = "timeCreated"
ListDeploymentTypesSortByDisplayname ListDeploymentTypesSortByEnum = "displayName"
)
func GetListDeploymentTypesSortByEnumValues() []ListDeploymentTypesSortByEnum
GetListDeploymentTypesSortByEnumValues Enumerates the set of values for ListDeploymentTypesSortByEnum
func GetMappingListDeploymentTypesSortByEnum(val string) (ListDeploymentTypesSortByEnum, bool)
GetMappingListDeploymentTypesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentTypesSortOrderEnum Enum with underlying type: string
type ListDeploymentTypesSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentTypesSortOrderEnum
const (
ListDeploymentTypesSortOrderAsc ListDeploymentTypesSortOrderEnum = "ASC"
ListDeploymentTypesSortOrderDesc ListDeploymentTypesSortOrderEnum = "DESC"
)
func GetListDeploymentTypesSortOrderEnumValues() []ListDeploymentTypesSortOrderEnum
GetListDeploymentTypesSortOrderEnumValues Enumerates the set of values for ListDeploymentTypesSortOrderEnum
func GetMappingListDeploymentTypesSortOrderEnum(val string) (ListDeploymentTypesSortOrderEnum, bool)
GetMappingListDeploymentTypesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentUpgradesLifecycleStateEnum Enum with underlying type: string
type ListDeploymentUpgradesLifecycleStateEnum string
Set of constants representing the allowable values for ListDeploymentUpgradesLifecycleStateEnum
const (
ListDeploymentUpgradesLifecycleStateCreating ListDeploymentUpgradesLifecycleStateEnum = "CREATING"
ListDeploymentUpgradesLifecycleStateUpdating ListDeploymentUpgradesLifecycleStateEnum = "UPDATING"
ListDeploymentUpgradesLifecycleStateActive ListDeploymentUpgradesLifecycleStateEnum = "ACTIVE"
ListDeploymentUpgradesLifecycleStateInactive ListDeploymentUpgradesLifecycleStateEnum = "INACTIVE"
ListDeploymentUpgradesLifecycleStateDeleting ListDeploymentUpgradesLifecycleStateEnum = "DELETING"
ListDeploymentUpgradesLifecycleStateDeleted ListDeploymentUpgradesLifecycleStateEnum = "DELETED"
ListDeploymentUpgradesLifecycleStateFailed ListDeploymentUpgradesLifecycleStateEnum = "FAILED"
ListDeploymentUpgradesLifecycleStateNeedsAttention ListDeploymentUpgradesLifecycleStateEnum = "NEEDS_ATTENTION"
ListDeploymentUpgradesLifecycleStateInProgress ListDeploymentUpgradesLifecycleStateEnum = "IN_PROGRESS"
ListDeploymentUpgradesLifecycleStateCanceling ListDeploymentUpgradesLifecycleStateEnum = "CANCELING"
ListDeploymentUpgradesLifecycleStateCanceled ListDeploymentUpgradesLifecycleStateEnum = "CANCELED"
ListDeploymentUpgradesLifecycleStateSucceeded ListDeploymentUpgradesLifecycleStateEnum = "SUCCEEDED"
ListDeploymentUpgradesLifecycleStateWaiting ListDeploymentUpgradesLifecycleStateEnum = "WAITING"
)
func GetListDeploymentUpgradesLifecycleStateEnumValues() []ListDeploymentUpgradesLifecycleStateEnum
GetListDeploymentUpgradesLifecycleStateEnumValues Enumerates the set of values for ListDeploymentUpgradesLifecycleStateEnum
func GetMappingListDeploymentUpgradesLifecycleStateEnum(val string) (ListDeploymentUpgradesLifecycleStateEnum, bool)
GetMappingListDeploymentUpgradesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentUpgradesRequest wrapper for the ListDeploymentUpgrades operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentUpgrades.go.html to see an example of how to use ListDeploymentUpgradesRequest.
type ListDeploymentUpgradesRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.
DeploymentId *string `mandatory:"false" contributesTo:"query" name:"deploymentId"`
// A filter to return only the resources that match the 'lifecycleState' given.
LifecycleState ListDeploymentUpgradesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDeploymentUpgradesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListDeploymentUpgradesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDeploymentUpgradesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentUpgradesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentUpgradesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentUpgradesRequest) String() string
func (request ListDeploymentUpgradesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDeploymentUpgradesResponse wrapper for the ListDeploymentUpgrades operation
type ListDeploymentUpgradesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentUpgradeCollection instances
DeploymentUpgradeCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDeploymentUpgradesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentUpgradesResponse) String() string
ListDeploymentUpgradesSortByEnum Enum with underlying type: string
type ListDeploymentUpgradesSortByEnum string
Set of constants representing the allowable values for ListDeploymentUpgradesSortByEnum
const (
ListDeploymentUpgradesSortByTimecreated ListDeploymentUpgradesSortByEnum = "timeCreated"
ListDeploymentUpgradesSortByDisplayname ListDeploymentUpgradesSortByEnum = "displayName"
)
func GetListDeploymentUpgradesSortByEnumValues() []ListDeploymentUpgradesSortByEnum
GetListDeploymentUpgradesSortByEnumValues Enumerates the set of values for ListDeploymentUpgradesSortByEnum
func GetMappingListDeploymentUpgradesSortByEnum(val string) (ListDeploymentUpgradesSortByEnum, bool)
GetMappingListDeploymentUpgradesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentUpgradesSortOrderEnum Enum with underlying type: string
type ListDeploymentUpgradesSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentUpgradesSortOrderEnum
const (
ListDeploymentUpgradesSortOrderAsc ListDeploymentUpgradesSortOrderEnum = "ASC"
ListDeploymentUpgradesSortOrderDesc ListDeploymentUpgradesSortOrderEnum = "DESC"
)
func GetListDeploymentUpgradesSortOrderEnumValues() []ListDeploymentUpgradesSortOrderEnum
GetListDeploymentUpgradesSortOrderEnumValues Enumerates the set of values for ListDeploymentUpgradesSortOrderEnum
func GetMappingListDeploymentUpgradesSortOrderEnum(val string) (ListDeploymentUpgradesSortOrderEnum, bool)
GetMappingListDeploymentUpgradesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentVersionsDeploymentTypeEnum Enum with underlying type: string
type ListDeploymentVersionsDeploymentTypeEnum string
Set of constants representing the allowable values for ListDeploymentVersionsDeploymentTypeEnum
const (
ListDeploymentVersionsDeploymentTypeOgg ListDeploymentVersionsDeploymentTypeEnum = "OGG"
ListDeploymentVersionsDeploymentTypeDatabaseOracle ListDeploymentVersionsDeploymentTypeEnum = "DATABASE_ORACLE"
ListDeploymentVersionsDeploymentTypeBigdata ListDeploymentVersionsDeploymentTypeEnum = "BIGDATA"
ListDeploymentVersionsDeploymentTypeDatabaseMicrosoftSqlserver ListDeploymentVersionsDeploymentTypeEnum = "DATABASE_MICROSOFT_SQLSERVER"
ListDeploymentVersionsDeploymentTypeDatabaseMysql ListDeploymentVersionsDeploymentTypeEnum = "DATABASE_MYSQL"
ListDeploymentVersionsDeploymentTypeDatabasePostgresql ListDeploymentVersionsDeploymentTypeEnum = "DATABASE_POSTGRESQL"
ListDeploymentVersionsDeploymentTypeDatabaseDb2zos ListDeploymentVersionsDeploymentTypeEnum = "DATABASE_DB2ZOS"
ListDeploymentVersionsDeploymentTypeGgsa ListDeploymentVersionsDeploymentTypeEnum = "GGSA"
ListDeploymentVersionsDeploymentTypeDataTransforms ListDeploymentVersionsDeploymentTypeEnum = "DATA_TRANSFORMS"
)
func GetListDeploymentVersionsDeploymentTypeEnumValues() []ListDeploymentVersionsDeploymentTypeEnum
GetListDeploymentVersionsDeploymentTypeEnumValues Enumerates the set of values for ListDeploymentVersionsDeploymentTypeEnum
func GetMappingListDeploymentVersionsDeploymentTypeEnum(val string) (ListDeploymentVersionsDeploymentTypeEnum, bool)
GetMappingListDeploymentVersionsDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentVersionsRequest wrapper for the ListDeploymentVersions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentVersions.go.html to see an example of how to use ListDeploymentVersionsRequest.
type ListDeploymentVersionsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.
DeploymentId *string `mandatory:"false" contributesTo:"query" name:"deploymentId"`
// The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE.
DeploymentType ListDeploymentVersionsDeploymentTypeEnum `mandatory:"false" contributesTo:"query" name:"deploymentType" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDeploymentVersionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListDeploymentVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDeploymentVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentVersionsRequest) String() string
func (request ListDeploymentVersionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDeploymentVersionsResponse wrapper for the ListDeploymentVersions operation
type ListDeploymentVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentVersionCollection instances
DeploymentVersionCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDeploymentVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentVersionsResponse) String() string
ListDeploymentVersionsSortByEnum Enum with underlying type: string
type ListDeploymentVersionsSortByEnum string
Set of constants representing the allowable values for ListDeploymentVersionsSortByEnum
const (
ListDeploymentVersionsSortByTimecreated ListDeploymentVersionsSortByEnum = "timeCreated"
ListDeploymentVersionsSortByDisplayname ListDeploymentVersionsSortByEnum = "displayName"
)
func GetListDeploymentVersionsSortByEnumValues() []ListDeploymentVersionsSortByEnum
GetListDeploymentVersionsSortByEnumValues Enumerates the set of values for ListDeploymentVersionsSortByEnum
func GetMappingListDeploymentVersionsSortByEnum(val string) (ListDeploymentVersionsSortByEnum, bool)
GetMappingListDeploymentVersionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentVersionsSortOrderEnum Enum with underlying type: string
type ListDeploymentVersionsSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentVersionsSortOrderEnum
const (
ListDeploymentVersionsSortOrderAsc ListDeploymentVersionsSortOrderEnum = "ASC"
ListDeploymentVersionsSortOrderDesc ListDeploymentVersionsSortOrderEnum = "DESC"
)
func GetListDeploymentVersionsSortOrderEnumValues() []ListDeploymentVersionsSortOrderEnum
GetListDeploymentVersionsSortOrderEnumValues Enumerates the set of values for ListDeploymentVersionsSortOrderEnum
func GetMappingListDeploymentVersionsSortOrderEnum(val string) (ListDeploymentVersionsSortOrderEnum, bool)
GetMappingListDeploymentVersionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentWalletsOperationsRequest wrapper for the ListDeploymentWalletsOperations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeploymentWalletsOperations.go.html to see an example of how to use ListDeploymentWalletsOperationsRequest.
type ListDeploymentWalletsOperationsRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeStarted' is
// descending.
SortBy ListDeploymentWalletsOperationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDeploymentWalletsOperationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDeploymentWalletsOperationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentWalletsOperationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentWalletsOperationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentWalletsOperationsRequest) String() string
func (request ListDeploymentWalletsOperationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDeploymentWalletsOperationsResponse wrapper for the ListDeploymentWalletsOperations operation
type ListDeploymentWalletsOperationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentWalletsOperationCollection instances
DeploymentWalletsOperationCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDeploymentWalletsOperationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentWalletsOperationsResponse) String() string
ListDeploymentWalletsOperationsSortByEnum Enum with underlying type: string
type ListDeploymentWalletsOperationsSortByEnum string
Set of constants representing the allowable values for ListDeploymentWalletsOperationsSortByEnum
const (
ListDeploymentWalletsOperationsSortByTimestarted ListDeploymentWalletsOperationsSortByEnum = "timeStarted"
)
func GetListDeploymentWalletsOperationsSortByEnumValues() []ListDeploymentWalletsOperationsSortByEnum
GetListDeploymentWalletsOperationsSortByEnumValues Enumerates the set of values for ListDeploymentWalletsOperationsSortByEnum
func GetMappingListDeploymentWalletsOperationsSortByEnum(val string) (ListDeploymentWalletsOperationsSortByEnum, bool)
GetMappingListDeploymentWalletsOperationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentWalletsOperationsSortOrderEnum Enum with underlying type: string
type ListDeploymentWalletsOperationsSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentWalletsOperationsSortOrderEnum
const (
ListDeploymentWalletsOperationsSortOrderAsc ListDeploymentWalletsOperationsSortOrderEnum = "ASC"
ListDeploymentWalletsOperationsSortOrderDesc ListDeploymentWalletsOperationsSortOrderEnum = "DESC"
)
func GetListDeploymentWalletsOperationsSortOrderEnumValues() []ListDeploymentWalletsOperationsSortOrderEnum
GetListDeploymentWalletsOperationsSortOrderEnumValues Enumerates the set of values for ListDeploymentWalletsOperationsSortOrderEnum
func GetMappingListDeploymentWalletsOperationsSortOrderEnum(val string) (ListDeploymentWalletsOperationsSortOrderEnum, bool)
GetMappingListDeploymentWalletsOperationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentsLifecycleStateEnum Enum with underlying type: string
type ListDeploymentsLifecycleStateEnum string
Set of constants representing the allowable values for ListDeploymentsLifecycleStateEnum
const (
ListDeploymentsLifecycleStateCreating ListDeploymentsLifecycleStateEnum = "CREATING"
ListDeploymentsLifecycleStateUpdating ListDeploymentsLifecycleStateEnum = "UPDATING"
ListDeploymentsLifecycleStateActive ListDeploymentsLifecycleStateEnum = "ACTIVE"
ListDeploymentsLifecycleStateInactive ListDeploymentsLifecycleStateEnum = "INACTIVE"
ListDeploymentsLifecycleStateDeleting ListDeploymentsLifecycleStateEnum = "DELETING"
ListDeploymentsLifecycleStateDeleted ListDeploymentsLifecycleStateEnum = "DELETED"
ListDeploymentsLifecycleStateFailed ListDeploymentsLifecycleStateEnum = "FAILED"
ListDeploymentsLifecycleStateNeedsAttention ListDeploymentsLifecycleStateEnum = "NEEDS_ATTENTION"
ListDeploymentsLifecycleStateInProgress ListDeploymentsLifecycleStateEnum = "IN_PROGRESS"
ListDeploymentsLifecycleStateCanceling ListDeploymentsLifecycleStateEnum = "CANCELING"
ListDeploymentsLifecycleStateCanceled ListDeploymentsLifecycleStateEnum = "CANCELED"
ListDeploymentsLifecycleStateSucceeded ListDeploymentsLifecycleStateEnum = "SUCCEEDED"
ListDeploymentsLifecycleStateWaiting ListDeploymentsLifecycleStateEnum = "WAITING"
)
func GetListDeploymentsLifecycleStateEnumValues() []ListDeploymentsLifecycleStateEnum
GetListDeploymentsLifecycleStateEnumValues Enumerates the set of values for ListDeploymentsLifecycleStateEnum
func GetMappingListDeploymentsLifecycleStateEnum(val string) (ListDeploymentsLifecycleStateEnum, bool)
GetMappingListDeploymentsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentsLifecycleSubStateEnum Enum with underlying type: string
type ListDeploymentsLifecycleSubStateEnum string
Set of constants representing the allowable values for ListDeploymentsLifecycleSubStateEnum
const (
ListDeploymentsLifecycleSubStateRecovering ListDeploymentsLifecycleSubStateEnum = "RECOVERING"
ListDeploymentsLifecycleSubStateStarting ListDeploymentsLifecycleSubStateEnum = "STARTING"
ListDeploymentsLifecycleSubStateStopping ListDeploymentsLifecycleSubStateEnum = "STOPPING"
ListDeploymentsLifecycleSubStateMoving ListDeploymentsLifecycleSubStateEnum = "MOVING"
ListDeploymentsLifecycleSubStateUpgrading ListDeploymentsLifecycleSubStateEnum = "UPGRADING"
ListDeploymentsLifecycleSubStateRestoring ListDeploymentsLifecycleSubStateEnum = "RESTORING"
ListDeploymentsLifecycleSubStateBackupInProgress ListDeploymentsLifecycleSubStateEnum = "BACKUP_IN_PROGRESS"
ListDeploymentsLifecycleSubStateRollbackInProgress ListDeploymentsLifecycleSubStateEnum = "ROLLBACK_IN_PROGRESS"
)
func GetListDeploymentsLifecycleSubStateEnumValues() []ListDeploymentsLifecycleSubStateEnum
GetListDeploymentsLifecycleSubStateEnumValues Enumerates the set of values for ListDeploymentsLifecycleSubStateEnum
func GetMappingListDeploymentsLifecycleSubStateEnum(val string) (ListDeploymentsLifecycleSubStateEnum, bool)
GetMappingListDeploymentsLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentsRequest wrapper for the ListDeployments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListDeployments.go.html to see an example of how to use ListDeploymentsRequest.
type ListDeploymentsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The connection type which the deployment must support.
SupportedConnectionType ListDeploymentsSupportedConnectionTypeEnum `mandatory:"false" contributesTo:"query" name:"supportedConnectionType" omitEmpty:"true"`
// The OCID of the connection which for the deployment must be assigned.
AssignedConnectionId *string `mandatory:"false" contributesTo:"query" name:"assignedConnectionId"`
// Return the deployments to which the specified connectionId may be assigned.
AssignableConnectionId *string `mandatory:"false" contributesTo:"query" name:"assignableConnectionId"`
// A filter to return only the resources that match the 'lifecycleState' given.
LifecycleState ListDeploymentsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only the resources that match the 'lifecycleSubState' given.
LifecycleSubState ListDeploymentsLifecycleSubStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleSubState" omitEmpty:"true"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only the resources that match the 'fqdn' given.
Fqdn *string `mandatory:"false" contributesTo:"query" name:"fqdn"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDeploymentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListDeploymentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDeploymentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentsRequest) String() string
func (request ListDeploymentsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDeploymentsResponse wrapper for the ListDeployments operation
type ListDeploymentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentCollection instances
DeploymentCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDeploymentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentsResponse) String() string
ListDeploymentsSortByEnum Enum with underlying type: string
type ListDeploymentsSortByEnum string
Set of constants representing the allowable values for ListDeploymentsSortByEnum
const (
ListDeploymentsSortByTimecreated ListDeploymentsSortByEnum = "timeCreated"
ListDeploymentsSortByDisplayname ListDeploymentsSortByEnum = "displayName"
)
func GetListDeploymentsSortByEnumValues() []ListDeploymentsSortByEnum
GetListDeploymentsSortByEnumValues Enumerates the set of values for ListDeploymentsSortByEnum
func GetMappingListDeploymentsSortByEnum(val string) (ListDeploymentsSortByEnum, bool)
GetMappingListDeploymentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentsSortOrderEnum Enum with underlying type: string
type ListDeploymentsSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentsSortOrderEnum
const (
ListDeploymentsSortOrderAsc ListDeploymentsSortOrderEnum = "ASC"
ListDeploymentsSortOrderDesc ListDeploymentsSortOrderEnum = "DESC"
)
func GetListDeploymentsSortOrderEnumValues() []ListDeploymentsSortOrderEnum
GetListDeploymentsSortOrderEnumValues Enumerates the set of values for ListDeploymentsSortOrderEnum
func GetMappingListDeploymentsSortOrderEnum(val string) (ListDeploymentsSortOrderEnum, bool)
GetMappingListDeploymentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentsSupportedConnectionTypeEnum Enum with underlying type: string
type ListDeploymentsSupportedConnectionTypeEnum string
Set of constants representing the allowable values for ListDeploymentsSupportedConnectionTypeEnum
const (
ListDeploymentsSupportedConnectionTypeGoldengate ListDeploymentsSupportedConnectionTypeEnum = "GOLDENGATE"
ListDeploymentsSupportedConnectionTypeKafka ListDeploymentsSupportedConnectionTypeEnum = "KAFKA"
ListDeploymentsSupportedConnectionTypeKafkaSchemaRegistry ListDeploymentsSupportedConnectionTypeEnum = "KAFKA_SCHEMA_REGISTRY"
ListDeploymentsSupportedConnectionTypeMysql ListDeploymentsSupportedConnectionTypeEnum = "MYSQL"
ListDeploymentsSupportedConnectionTypeJavaMessageService ListDeploymentsSupportedConnectionTypeEnum = "JAVA_MESSAGE_SERVICE"
ListDeploymentsSupportedConnectionTypeMicrosoftSqlserver ListDeploymentsSupportedConnectionTypeEnum = "MICROSOFT_SQLSERVER"
ListDeploymentsSupportedConnectionTypeOciObjectStorage ListDeploymentsSupportedConnectionTypeEnum = "OCI_OBJECT_STORAGE"
ListDeploymentsSupportedConnectionTypeOracle ListDeploymentsSupportedConnectionTypeEnum = "ORACLE"
ListDeploymentsSupportedConnectionTypeAzureDataLakeStorage ListDeploymentsSupportedConnectionTypeEnum = "AZURE_DATA_LAKE_STORAGE"
ListDeploymentsSupportedConnectionTypePostgresql ListDeploymentsSupportedConnectionTypeEnum = "POSTGRESQL"
ListDeploymentsSupportedConnectionTypeAzureSynapseAnalytics ListDeploymentsSupportedConnectionTypeEnum = "AZURE_SYNAPSE_ANALYTICS"
ListDeploymentsSupportedConnectionTypeSnowflake ListDeploymentsSupportedConnectionTypeEnum = "SNOWFLAKE"
ListDeploymentsSupportedConnectionTypeAmazonS3 ListDeploymentsSupportedConnectionTypeEnum = "AMAZON_S3"
ListDeploymentsSupportedConnectionTypeHdfs ListDeploymentsSupportedConnectionTypeEnum = "HDFS"
ListDeploymentsSupportedConnectionTypeOracleNosql ListDeploymentsSupportedConnectionTypeEnum = "ORACLE_NOSQL"
ListDeploymentsSupportedConnectionTypeMongodb ListDeploymentsSupportedConnectionTypeEnum = "MONGODB"
ListDeploymentsSupportedConnectionTypeAmazonKinesis ListDeploymentsSupportedConnectionTypeEnum = "AMAZON_KINESIS"
ListDeploymentsSupportedConnectionTypeAmazonRedshift ListDeploymentsSupportedConnectionTypeEnum = "AMAZON_REDSHIFT"
ListDeploymentsSupportedConnectionTypeDb2 ListDeploymentsSupportedConnectionTypeEnum = "DB2"
ListDeploymentsSupportedConnectionTypeRedis ListDeploymentsSupportedConnectionTypeEnum = "REDIS"
ListDeploymentsSupportedConnectionTypeElasticsearch ListDeploymentsSupportedConnectionTypeEnum = "ELASTICSEARCH"
ListDeploymentsSupportedConnectionTypeGeneric ListDeploymentsSupportedConnectionTypeEnum = "GENERIC"
ListDeploymentsSupportedConnectionTypeGoogleCloudStorage ListDeploymentsSupportedConnectionTypeEnum = "GOOGLE_CLOUD_STORAGE"
ListDeploymentsSupportedConnectionTypeGoogleBigquery ListDeploymentsSupportedConnectionTypeEnum = "GOOGLE_BIGQUERY"
ListDeploymentsSupportedConnectionTypeDatabricks ListDeploymentsSupportedConnectionTypeEnum = "DATABRICKS"
ListDeploymentsSupportedConnectionTypeGooglePubsub ListDeploymentsSupportedConnectionTypeEnum = "GOOGLE_PUBSUB"
ListDeploymentsSupportedConnectionTypeMicrosoftFabric ListDeploymentsSupportedConnectionTypeEnum = "MICROSOFT_FABRIC"
)
func GetListDeploymentsSupportedConnectionTypeEnumValues() []ListDeploymentsSupportedConnectionTypeEnum
GetListDeploymentsSupportedConnectionTypeEnumValues Enumerates the set of values for ListDeploymentsSupportedConnectionTypeEnum
func GetMappingListDeploymentsSupportedConnectionTypeEnum(val string) (ListDeploymentsSupportedConnectionTypeEnum, bool)
GetMappingListDeploymentsSupportedConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListMessagesRequest wrapper for the ListMessages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListMessages.go.html to see an example of how to use ListMessagesRequest.
type ListMessagesRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"query" name:"deploymentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListMessagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMessagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMessagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMessagesRequest) String() string
func (request ListMessagesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListMessagesResponse wrapper for the ListMessages operation
type ListMessagesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentMessageCollection instances
DeploymentMessageCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListMessagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMessagesResponse) String() string
ListPipelineInitializationStepsRequest wrapper for the ListPipelineInitializationSteps operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineInitializationSteps.go.html to see an example of how to use ListPipelineInitializationStepsRequest.
type ListPipelineInitializationStepsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPipelineInitializationStepsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPipelineInitializationStepsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPipelineInitializationStepsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPipelineInitializationStepsRequest) String() string
func (request ListPipelineInitializationStepsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPipelineInitializationStepsResponse wrapper for the ListPipelineInitializationSteps operation
type ListPipelineInitializationStepsResponse struct {
// The underlying http response
RawResponse *http.Response
// The PipelineInitializationSteps instance
PipelineInitializationSteps `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListPipelineInitializationStepsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPipelineInitializationStepsResponse) String() string
ListPipelineRunningProcessesRequest wrapper for the ListPipelineRunningProcesses operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineRunningProcesses.go.html to see an example of how to use ListPipelineRunningProcessesRequest.
type ListPipelineRunningProcessesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListPipelineRunningProcessesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListPipelineRunningProcessesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPipelineRunningProcessesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPipelineRunningProcessesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPipelineRunningProcessesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPipelineRunningProcessesRequest) String() string
func (request ListPipelineRunningProcessesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPipelineRunningProcessesResponse wrapper for the ListPipelineRunningProcesses operation
type ListPipelineRunningProcessesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PipelineRunningProcessCollection instances
PipelineRunningProcessCollection `presentIn:"body"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListPipelineRunningProcessesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPipelineRunningProcessesResponse) String() string
ListPipelineRunningProcessesSortByEnum Enum with underlying type: string
type ListPipelineRunningProcessesSortByEnum string
Set of constants representing the allowable values for ListPipelineRunningProcessesSortByEnum
const (
ListPipelineRunningProcessesSortByTimecreated ListPipelineRunningProcessesSortByEnum = "timeCreated"
ListPipelineRunningProcessesSortByDisplayname ListPipelineRunningProcessesSortByEnum = "displayName"
)
func GetListPipelineRunningProcessesSortByEnumValues() []ListPipelineRunningProcessesSortByEnum
GetListPipelineRunningProcessesSortByEnumValues Enumerates the set of values for ListPipelineRunningProcessesSortByEnum
func GetMappingListPipelineRunningProcessesSortByEnum(val string) (ListPipelineRunningProcessesSortByEnum, bool)
GetMappingListPipelineRunningProcessesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelineRunningProcessesSortOrderEnum Enum with underlying type: string
type ListPipelineRunningProcessesSortOrderEnum string
Set of constants representing the allowable values for ListPipelineRunningProcessesSortOrderEnum
const (
ListPipelineRunningProcessesSortOrderAsc ListPipelineRunningProcessesSortOrderEnum = "ASC"
ListPipelineRunningProcessesSortOrderDesc ListPipelineRunningProcessesSortOrderEnum = "DESC"
)
func GetListPipelineRunningProcessesSortOrderEnumValues() []ListPipelineRunningProcessesSortOrderEnum
GetListPipelineRunningProcessesSortOrderEnumValues Enumerates the set of values for ListPipelineRunningProcessesSortOrderEnum
func GetMappingListPipelineRunningProcessesSortOrderEnum(val string) (ListPipelineRunningProcessesSortOrderEnum, bool)
GetMappingListPipelineRunningProcessesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelineSchemaTablesRequest wrapper for the ListPipelineSchemaTables operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineSchemaTables.go.html to see an example of how to use ListPipelineSchemaTablesRequest.
type ListPipelineSchemaTablesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// Name of the source schema obtained from get schema endpoint of the created pipeline.
SourceSchemaName *string `mandatory:"true" contributesTo:"query" name:"sourceSchemaName"`
// Name of the target schema obtained from get schema endpoint of the created pipeline.
TargetSchemaName *string `mandatory:"true" contributesTo:"query" name:"targetSchemaName"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListPipelineSchemaTablesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListPipelineSchemaTablesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPipelineSchemaTablesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPipelineSchemaTablesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPipelineSchemaTablesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPipelineSchemaTablesRequest) String() string
func (request ListPipelineSchemaTablesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPipelineSchemaTablesResponse wrapper for the ListPipelineSchemaTables operation
type ListPipelineSchemaTablesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PipelineSchemaTableCollection instances
PipelineSchemaTableCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPipelineSchemaTablesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPipelineSchemaTablesResponse) String() string
ListPipelineSchemaTablesSortByEnum Enum with underlying type: string
type ListPipelineSchemaTablesSortByEnum string
Set of constants representing the allowable values for ListPipelineSchemaTablesSortByEnum
const (
ListPipelineSchemaTablesSortByTimecreated ListPipelineSchemaTablesSortByEnum = "timeCreated"
ListPipelineSchemaTablesSortByDisplayname ListPipelineSchemaTablesSortByEnum = "displayName"
)
func GetListPipelineSchemaTablesSortByEnumValues() []ListPipelineSchemaTablesSortByEnum
GetListPipelineSchemaTablesSortByEnumValues Enumerates the set of values for ListPipelineSchemaTablesSortByEnum
func GetMappingListPipelineSchemaTablesSortByEnum(val string) (ListPipelineSchemaTablesSortByEnum, bool)
GetMappingListPipelineSchemaTablesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelineSchemaTablesSortOrderEnum Enum with underlying type: string
type ListPipelineSchemaTablesSortOrderEnum string
Set of constants representing the allowable values for ListPipelineSchemaTablesSortOrderEnum
const (
ListPipelineSchemaTablesSortOrderAsc ListPipelineSchemaTablesSortOrderEnum = "ASC"
ListPipelineSchemaTablesSortOrderDesc ListPipelineSchemaTablesSortOrderEnum = "DESC"
)
func GetListPipelineSchemaTablesSortOrderEnumValues() []ListPipelineSchemaTablesSortOrderEnum
GetListPipelineSchemaTablesSortOrderEnumValues Enumerates the set of values for ListPipelineSchemaTablesSortOrderEnum
func GetMappingListPipelineSchemaTablesSortOrderEnum(val string) (ListPipelineSchemaTablesSortOrderEnum, bool)
GetMappingListPipelineSchemaTablesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelineSchemasRequest wrapper for the ListPipelineSchemas operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelineSchemas.go.html to see an example of how to use ListPipelineSchemasRequest.
type ListPipelineSchemasRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListPipelineSchemasSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListPipelineSchemasSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPipelineSchemasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPipelineSchemasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPipelineSchemasRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPipelineSchemasRequest) String() string
func (request ListPipelineSchemasRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPipelineSchemasResponse wrapper for the ListPipelineSchemas operation
type ListPipelineSchemasResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PipelineSchemaCollection instances
PipelineSchemaCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPipelineSchemasResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPipelineSchemasResponse) String() string
ListPipelineSchemasSortByEnum Enum with underlying type: string
type ListPipelineSchemasSortByEnum string
Set of constants representing the allowable values for ListPipelineSchemasSortByEnum
const (
ListPipelineSchemasSortByTimecreated ListPipelineSchemasSortByEnum = "timeCreated"
ListPipelineSchemasSortByDisplayname ListPipelineSchemasSortByEnum = "displayName"
)
func GetListPipelineSchemasSortByEnumValues() []ListPipelineSchemasSortByEnum
GetListPipelineSchemasSortByEnumValues Enumerates the set of values for ListPipelineSchemasSortByEnum
func GetMappingListPipelineSchemasSortByEnum(val string) (ListPipelineSchemasSortByEnum, bool)
GetMappingListPipelineSchemasSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelineSchemasSortOrderEnum Enum with underlying type: string
type ListPipelineSchemasSortOrderEnum string
Set of constants representing the allowable values for ListPipelineSchemasSortOrderEnum
const (
ListPipelineSchemasSortOrderAsc ListPipelineSchemasSortOrderEnum = "ASC"
ListPipelineSchemasSortOrderDesc ListPipelineSchemasSortOrderEnum = "DESC"
)
func GetListPipelineSchemasSortOrderEnumValues() []ListPipelineSchemasSortOrderEnum
GetListPipelineSchemasSortOrderEnumValues Enumerates the set of values for ListPipelineSchemasSortOrderEnum
func GetMappingListPipelineSchemasSortOrderEnum(val string) (ListPipelineSchemasSortOrderEnum, bool)
GetMappingListPipelineSchemasSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelinesLifecycleSubStateEnum Enum with underlying type: string
type ListPipelinesLifecycleSubStateEnum string
Set of constants representing the allowable values for ListPipelinesLifecycleSubStateEnum
const (
ListPipelinesLifecycleSubStateStarting ListPipelinesLifecycleSubStateEnum = "STARTING"
ListPipelinesLifecycleSubStateStopping ListPipelinesLifecycleSubStateEnum = "STOPPING"
ListPipelinesLifecycleSubStateStopped ListPipelinesLifecycleSubStateEnum = "STOPPED"
ListPipelinesLifecycleSubStateMoving ListPipelinesLifecycleSubStateEnum = "MOVING"
ListPipelinesLifecycleSubStateRunning ListPipelinesLifecycleSubStateEnum = "RUNNING"
)
func GetListPipelinesLifecycleSubStateEnumValues() []ListPipelinesLifecycleSubStateEnum
GetListPipelinesLifecycleSubStateEnumValues Enumerates the set of values for ListPipelinesLifecycleSubStateEnum
func GetMappingListPipelinesLifecycleSubStateEnum(val string) (ListPipelinesLifecycleSubStateEnum, bool)
GetMappingListPipelinesLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelinesRequest wrapper for the ListPipelines operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListPipelines.go.html to see an example of how to use ListPipelinesRequest.
type ListPipelinesRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filtered list of pipelines to return for a given lifecycleState.
LifecycleState PipelineLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filtered list of pipelines to return for a given lifecycleSubState.
LifecycleSubState ListPipelinesLifecycleSubStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleSubState" omitEmpty:"true"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListPipelinesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListPipelinesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPipelinesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPipelinesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPipelinesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPipelinesRequest) String() string
func (request ListPipelinesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPipelinesResponse wrapper for the ListPipelines operation
type ListPipelinesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PipelineCollection instances
PipelineCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPipelinesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPipelinesResponse) String() string
ListPipelinesSortByEnum Enum with underlying type: string
type ListPipelinesSortByEnum string
Set of constants representing the allowable values for ListPipelinesSortByEnum
const (
ListPipelinesSortByTimecreated ListPipelinesSortByEnum = "timeCreated"
ListPipelinesSortByDisplayname ListPipelinesSortByEnum = "displayName"
)
func GetListPipelinesSortByEnumValues() []ListPipelinesSortByEnum
GetListPipelinesSortByEnumValues Enumerates the set of values for ListPipelinesSortByEnum
func GetMappingListPipelinesSortByEnum(val string) (ListPipelinesSortByEnum, bool)
GetMappingListPipelinesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPipelinesSortOrderEnum Enum with underlying type: string
type ListPipelinesSortOrderEnum string
Set of constants representing the allowable values for ListPipelinesSortOrderEnum
const (
ListPipelinesSortOrderAsc ListPipelinesSortOrderEnum = "ASC"
ListPipelinesSortOrderDesc ListPipelinesSortOrderEnum = "DESC"
)
func GetListPipelinesSortOrderEnumValues() []ListPipelinesSortOrderEnum
GetListPipelinesSortOrderEnumValues Enumerates the set of values for ListPipelinesSortOrderEnum
func GetMappingListPipelinesSortOrderEnum(val string) (ListPipelinesSortOrderEnum, bool)
GetMappingListPipelinesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecipesRecipeTypeEnum Enum with underlying type: string
type ListRecipesRecipeTypeEnum string
Set of constants representing the allowable values for ListRecipesRecipeTypeEnum
const (
ListRecipesRecipeTypeZeroEtl ListRecipesRecipeTypeEnum = "ZERO_ETL"
)
func GetListRecipesRecipeTypeEnumValues() []ListRecipesRecipeTypeEnum
GetListRecipesRecipeTypeEnumValues Enumerates the set of values for ListRecipesRecipeTypeEnum
func GetMappingListRecipesRecipeTypeEnum(val string) (ListRecipesRecipeTypeEnum, bool)
GetMappingListRecipesRecipeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecipesRequest wrapper for the ListRecipes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListRecipes.go.html to see an example of how to use ListRecipesRequest.
type ListRecipesRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The pipeline's recipe type. The default value is ZERO_ETL.
RecipeType ListRecipesRecipeTypeEnum `mandatory:"false" contributesTo:"query" name:"recipeType" omitEmpty:"true"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListRecipesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// timeCreated is the default.
SortBy ListRecipesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRecipesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRecipesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRecipesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRecipesRequest) String() string
func (request ListRecipesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListRecipesResponse wrapper for the ListRecipes operation
type ListRecipesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RecipeSummaryCollection instances
RecipeSummaryCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRecipesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRecipesResponse) String() string
ListRecipesSortByEnum Enum with underlying type: string
type ListRecipesSortByEnum string
Set of constants representing the allowable values for ListRecipesSortByEnum
const (
ListRecipesSortByTimecreated ListRecipesSortByEnum = "timeCreated"
ListRecipesSortByDisplayname ListRecipesSortByEnum = "displayName"
)
func GetListRecipesSortByEnumValues() []ListRecipesSortByEnum
GetListRecipesSortByEnumValues Enumerates the set of values for ListRecipesSortByEnum
func GetMappingListRecipesSortByEnum(val string) (ListRecipesSortByEnum, bool)
GetMappingListRecipesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecipesSortOrderEnum Enum with underlying type: string
type ListRecipesSortOrderEnum string
Set of constants representing the allowable values for ListRecipesSortOrderEnum
const (
ListRecipesSortOrderAsc ListRecipesSortOrderEnum = "ASC"
ListRecipesSortOrderDesc ListRecipesSortOrderEnum = "DESC"
)
func GetListRecipesSortOrderEnumValues() []ListRecipesSortOrderEnum
GetListRecipesSortOrderEnumValues Enumerates the set of values for ListRecipesSortOrderEnum
func GetMappingListRecipesSortOrderEnum(val string) (ListRecipesSortOrderEnum, bool)
GetMappingListRecipesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTrailFilesRequest wrapper for the ListTrailFiles operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListTrailFiles.go.html to see an example of how to use ListTrailFilesRequest.
type ListTrailFilesRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"query" name:"deploymentId"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A Trail File identifier
TrailFileId *string `mandatory:"false" contributesTo:"query" name:"trailFileId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// displayName is the default.
SortBy ListTrailFilesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListTrailFilesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListTrailFilesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTrailFilesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTrailFilesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTrailFilesRequest) String() string
func (request ListTrailFilesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTrailFilesResponse wrapper for the ListTrailFiles operation
type ListTrailFilesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TrailFileCollection instances
TrailFileCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListTrailFilesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTrailFilesResponse) String() string
ListTrailFilesSortByEnum Enum with underlying type: string
type ListTrailFilesSortByEnum string
Set of constants representing the allowable values for ListTrailFilesSortByEnum
const (
ListTrailFilesSortByTimelastupdated ListTrailFilesSortByEnum = "timeLastUpdated"
ListTrailFilesSortByDisplayname ListTrailFilesSortByEnum = "displayName"
)
func GetListTrailFilesSortByEnumValues() []ListTrailFilesSortByEnum
GetListTrailFilesSortByEnumValues Enumerates the set of values for ListTrailFilesSortByEnum
func GetMappingListTrailFilesSortByEnum(val string) (ListTrailFilesSortByEnum, bool)
GetMappingListTrailFilesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTrailFilesSortOrderEnum Enum with underlying type: string
type ListTrailFilesSortOrderEnum string
Set of constants representing the allowable values for ListTrailFilesSortOrderEnum
const (
ListTrailFilesSortOrderAsc ListTrailFilesSortOrderEnum = "ASC"
ListTrailFilesSortOrderDesc ListTrailFilesSortOrderEnum = "DESC"
)
func GetListTrailFilesSortOrderEnumValues() []ListTrailFilesSortOrderEnum
GetListTrailFilesSortOrderEnumValues Enumerates the set of values for ListTrailFilesSortOrderEnum
func GetMappingListTrailFilesSortOrderEnum(val string) (ListTrailFilesSortOrderEnum, bool)
GetMappingListTrailFilesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTrailSequencesRequest wrapper for the ListTrailSequences operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListTrailSequences.go.html to see an example of how to use ListTrailSequencesRequest.
type ListTrailSequencesRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"query" name:"deploymentId"`
// A Trail File identifier
TrailFileId *string `mandatory:"true" contributesTo:"query" name:"trailFileId"`
// A Trail Sequence identifier
TrailSequenceId *string `mandatory:"false" contributesTo:"query" name:"trailSequenceId"`
// A filter to return only the resources that match the entire 'displayName' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is
// descending. Default order for 'displayName' is ascending. If no value is specified
// displayName is the default.
SortBy ListTrailSequencesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListTrailSequencesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListTrailSequencesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTrailSequencesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTrailSequencesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTrailSequencesRequest) String() string
func (request ListTrailSequencesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTrailSequencesResponse wrapper for the ListTrailSequences operation
type ListTrailSequencesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TrailSequenceCollection instances
TrailSequenceCollection `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListTrailSequencesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTrailSequencesResponse) String() string
ListTrailSequencesSortByEnum Enum with underlying type: string
type ListTrailSequencesSortByEnum string
Set of constants representing the allowable values for ListTrailSequencesSortByEnum
const (
ListTrailSequencesSortByTimelastupdated ListTrailSequencesSortByEnum = "timeLastUpdated"
ListTrailSequencesSortByDisplayname ListTrailSequencesSortByEnum = "displayName"
)
func GetListTrailSequencesSortByEnumValues() []ListTrailSequencesSortByEnum
GetListTrailSequencesSortByEnumValues Enumerates the set of values for ListTrailSequencesSortByEnum
func GetMappingListTrailSequencesSortByEnum(val string) (ListTrailSequencesSortByEnum, bool)
GetMappingListTrailSequencesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTrailSequencesSortOrderEnum Enum with underlying type: string
type ListTrailSequencesSortOrderEnum string
Set of constants representing the allowable values for ListTrailSequencesSortOrderEnum
const (
ListTrailSequencesSortOrderAsc ListTrailSequencesSortOrderEnum = "ASC"
ListTrailSequencesSortOrderDesc ListTrailSequencesSortOrderEnum = "DESC"
)
func GetListTrailSequencesSortOrderEnumValues() []ListTrailSequencesSortOrderEnum
GetListTrailSequencesSortOrderEnumValues Enumerates the set of values for ListTrailSequencesSortOrderEnum
func GetMappingListTrailSequencesSortOrderEnum(val string) (ListTrailSequencesSortOrderEnum, bool)
GetMappingListTrailSequencesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestError instances
Items []WorkRequestError `presentIn:"body"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `presentIn:"body"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request concerns
// multiple resources, and those resources are not in the same compartment, it is up to the service team
// to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource in which to list resources.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually
// retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequest instances
Items []WorkRequest `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The page token represents the page to start retrieving results. This is usually retrieved
// from a previous list call.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
MaintenanceActionTypeEnum Enum with underlying type: string
type MaintenanceActionTypeEnum string
Set of constants representing the allowable values for MaintenanceActionTypeEnum
const (
MaintenanceActionTypeUpgrade MaintenanceActionTypeEnum = "UPGRADE"
)
func GetMaintenanceActionTypeEnumValues() []MaintenanceActionTypeEnum
GetMaintenanceActionTypeEnumValues Enumerates the set of values for MaintenanceActionTypeEnum
func GetMappingMaintenanceActionTypeEnum(val string) (MaintenanceActionTypeEnum, bool)
GetMappingMaintenanceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
MaintenanceConfiguration Attributes for configuring automatic deployment maintenance.
type MaintenanceConfiguration struct {
// By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release,
// you have to specify interimReleaseUpgradePeriodInDays too.
IsInterimReleaseAutoUpgradeEnabled *bool `mandatory:"true" json:"isInterimReleaseAutoUpgradeEnabled"`
// Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases.
// This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
BundleReleaseUpgradePeriodInDays *int `mandatory:"true" json:"bundleReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases.
// Not passing this field during create will equate to using the service default.
MajorReleaseUpgradePeriodInDays *int `mandatory:"true" json:"majorReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases.
// Not passing this field during create will equate to using the service default.
SecurityPatchUpgradePeriodInDays *int `mandatory:"true" json:"securityPatchUpgradePeriodInDays"`
// Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
InterimReleaseUpgradePeriodInDays *int `mandatory:"false" json:"interimReleaseUpgradePeriodInDays"`
}
func (m MaintenanceConfiguration) String() string
func (m MaintenanceConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MaintenanceWindow Defines the maintenance window, when automatic actions can be performed.
type MaintenanceWindow struct {
// Days of the week.
Day DayEnum `mandatory:"true" json:"day"`
// Start hour for maintenance period. Hour is in UTC.
StartHour *int `mandatory:"true" json:"startHour"`
}
func (m MaintenanceWindow) String() string
func (m MaintenanceWindow) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MappingRule Mapping rule for source and target schemas for the pipeline data replication. For example: "{mappingType: INCLUDE, source: HR.*, target: HR.*}" for rule "Include HR.*" which will include all the tables under HR schema.
type MappingRule struct {
// Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.
MappingType MappingTypeEnum `mandatory:"true" json:"mappingType"`
// The source schema/table combination for replication to target.
Source *string `mandatory:"true" json:"source"`
// The target schema/table combination for replication from the source.
Target *string `mandatory:"false" json:"target"`
}
func (m MappingRule) String() string
func (m MappingRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MappingTypeEnum Enum with underlying type: string
type MappingTypeEnum string
Set of constants representing the allowable values for MappingTypeEnum
const (
MappingTypeInclude MappingTypeEnum = "INCLUDE"
MappingTypeExclude MappingTypeEnum = "EXCLUDE"
)
func GetMappingMappingTypeEnum(val string) (MappingTypeEnum, bool)
GetMappingMappingTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingTypeEnumValues() []MappingTypeEnum
GetMappingTypeEnumValues Enumerates the set of values for MappingTypeEnum
MessageSummary Deployment message Summary.
type MessageSummary struct {
// The deployment Message Id.
Id *string `mandatory:"true" json:"id"`
// The deployment Message in plain text with optional HTML anchor tags.
DeploymentMessage *string `mandatory:"true" json:"deploymentMessage"`
// The deployment Message Status.
DeploymentMessageStatus MessageSummaryDeploymentMessageStatusEnum `mandatory:"true" json:"deploymentMessageStatus"`
}
func (m MessageSummary) String() string
func (m MessageSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MessageSummaryDeploymentMessageStatusEnum Enum with underlying type: string
type MessageSummaryDeploymentMessageStatusEnum string
Set of constants representing the allowable values for MessageSummaryDeploymentMessageStatusEnum
const (
MessageSummaryDeploymentMessageStatusInfo MessageSummaryDeploymentMessageStatusEnum = "INFO"
MessageSummaryDeploymentMessageStatusWarning MessageSummaryDeploymentMessageStatusEnum = "WARNING"
MessageSummaryDeploymentMessageStatusError MessageSummaryDeploymentMessageStatusEnum = "ERROR"
)
func GetMappingMessageSummaryDeploymentMessageStatusEnum(val string) (MessageSummaryDeploymentMessageStatusEnum, bool)
GetMappingMessageSummaryDeploymentMessageStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMessageSummaryDeploymentMessageStatusEnumValues() []MessageSummaryDeploymentMessageStatusEnum
GetMessageSummaryDeploymentMessageStatusEnumValues Enumerates the set of values for MessageSummaryDeploymentMessageStatusEnum
MicrosoftFabricConnection Represents the metadata of a Microsoft Fabric Connection.
type MicrosoftFabricConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Azure tenant ID of the application.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
TenantId *string `mandatory:"true" json:"tenantId"`
// Azure client ID of the application.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"true" json:"clientId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional Microsoft Fabric service endpoint.
// Default value: https://onelake.dfs.fabric.microsoft.com
Endpoint *string `mandatory:"false" json:"endpoint"`
// The Microsoft Fabric technology type.
TechnologyType MicrosoftFabricConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m MicrosoftFabricConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MicrosoftFabricConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MicrosoftFabricConnection) GetDescription() *string
GetDescription returns Description
func (m MicrosoftFabricConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MicrosoftFabricConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MicrosoftFabricConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MicrosoftFabricConnection) GetId() *string
GetId returns Id
func (m MicrosoftFabricConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MicrosoftFabricConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m MicrosoftFabricConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MicrosoftFabricConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MicrosoftFabricConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MicrosoftFabricConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MicrosoftFabricConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MicrosoftFabricConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MicrosoftFabricConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MicrosoftFabricConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MicrosoftFabricConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MicrosoftFabricConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m MicrosoftFabricConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MicrosoftFabricConnection) String() string
func (m MicrosoftFabricConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MicrosoftFabricConnectionSummary Summary of the Microsoft Fabric Connection.
type MicrosoftFabricConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Azure tenant ID of the application.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
TenantId *string `mandatory:"true" json:"tenantId"`
// Azure client ID of the application.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"true" json:"clientId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional Microsoft Fabric service endpoint.
// Default value: https://onelake.dfs.fabric.microsoft.com
Endpoint *string `mandatory:"false" json:"endpoint"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Microsoft Fabric technology type.
TechnologyType MicrosoftFabricConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m MicrosoftFabricConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MicrosoftFabricConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MicrosoftFabricConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m MicrosoftFabricConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MicrosoftFabricConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MicrosoftFabricConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MicrosoftFabricConnectionSummary) GetId() *string
GetId returns Id
func (m MicrosoftFabricConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MicrosoftFabricConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m MicrosoftFabricConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MicrosoftFabricConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MicrosoftFabricConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MicrosoftFabricConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MicrosoftFabricConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MicrosoftFabricConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MicrosoftFabricConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MicrosoftFabricConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MicrosoftFabricConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MicrosoftFabricConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m MicrosoftFabricConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MicrosoftFabricConnectionSummary) String() string
func (m MicrosoftFabricConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MicrosoftFabricConnectionTechnologyTypeEnum Enum with underlying type: string
type MicrosoftFabricConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for MicrosoftFabricConnectionTechnologyTypeEnum
const (
MicrosoftFabricConnectionTechnologyTypeLakehouse MicrosoftFabricConnectionTechnologyTypeEnum = "MICROSOFT_FABRIC_LAKEHOUSE"
MicrosoftFabricConnectionTechnologyTypeMirror MicrosoftFabricConnectionTechnologyTypeEnum = "MICROSOFT_FABRIC_MIRROR"
)
func GetMappingMicrosoftFabricConnectionTechnologyTypeEnum(val string) (MicrosoftFabricConnectionTechnologyTypeEnum, bool)
GetMappingMicrosoftFabricConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMicrosoftFabricConnectionTechnologyTypeEnumValues() []MicrosoftFabricConnectionTechnologyTypeEnum
GetMicrosoftFabricConnectionTechnologyTypeEnumValues Enumerates the set of values for MicrosoftFabricConnectionTechnologyTypeEnum
MicrosoftSqlserverConnection Represents the metadata of a Microsoft SQL Server Connection.
type MicrosoftSqlserverConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The username Oracle GoldenGate uses to connect to the Microsoft SQL Server.
// This username must already exist and be available by the Microsoft SQL Server to be connected to.
Username *string `mandatory:"true" json:"username"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// Database Certificate - The base64 encoded content of a .pem or .crt file.
// containing the server public key (for 1-way SSL).
SslCa *string `mandatory:"false" json:"sslCa"`
// If set to true, the driver validates the certificate that is sent by the database server.
ShouldValidateServerCertificate *bool `mandatory:"false" json:"shouldValidateServerCertificate"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The Microsoft SQL Server technology type.
TechnologyType MicrosoftSqlserverConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Protocol for Microsoft SQL Server.
SecurityProtocol MicrosoftSqlserverConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m MicrosoftSqlserverConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MicrosoftSqlserverConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MicrosoftSqlserverConnection) GetDescription() *string
GetDescription returns Description
func (m MicrosoftSqlserverConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MicrosoftSqlserverConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MicrosoftSqlserverConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MicrosoftSqlserverConnection) GetId() *string
GetId returns Id
func (m MicrosoftSqlserverConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MicrosoftSqlserverConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m MicrosoftSqlserverConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MicrosoftSqlserverConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MicrosoftSqlserverConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MicrosoftSqlserverConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MicrosoftSqlserverConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MicrosoftSqlserverConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MicrosoftSqlserverConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MicrosoftSqlserverConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MicrosoftSqlserverConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MicrosoftSqlserverConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m MicrosoftSqlserverConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MicrosoftSqlserverConnection) String() string
func (m MicrosoftSqlserverConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MicrosoftSqlserverConnectionSecurityProtocolEnum Enum with underlying type: string
type MicrosoftSqlserverConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for MicrosoftSqlserverConnectionSecurityProtocolEnum
const (
MicrosoftSqlserverConnectionSecurityProtocolPlain MicrosoftSqlserverConnectionSecurityProtocolEnum = "PLAIN"
MicrosoftSqlserverConnectionSecurityProtocolTls MicrosoftSqlserverConnectionSecurityProtocolEnum = "TLS"
)
func GetMappingMicrosoftSqlserverConnectionSecurityProtocolEnum(val string) (MicrosoftSqlserverConnectionSecurityProtocolEnum, bool)
GetMappingMicrosoftSqlserverConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMicrosoftSqlserverConnectionSecurityProtocolEnumValues() []MicrosoftSqlserverConnectionSecurityProtocolEnum
GetMicrosoftSqlserverConnectionSecurityProtocolEnumValues Enumerates the set of values for MicrosoftSqlserverConnectionSecurityProtocolEnum
MicrosoftSqlserverConnectionSummary Summary of the Microsoft SQL Server Connection.
type MicrosoftSqlserverConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The username Oracle GoldenGate uses to connect to the Microsoft SQL Server.
// This username must already exist and be available by the Microsoft SQL Server to be connected to.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// Database Certificate - The base64 encoded content of a .pem or .crt file.
// containing the server public key (for 1-way SSL).
SslCa *string `mandatory:"false" json:"sslCa"`
// If set to true, the driver validates the certificate that is sent by the database server.
ShouldValidateServerCertificate *bool `mandatory:"false" json:"shouldValidateServerCertificate"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Microsoft SQL Server technology type.
TechnologyType MicrosoftSqlserverConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for Microsoft SQL Server.
SecurityProtocol MicrosoftSqlserverConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
}
func (m MicrosoftSqlserverConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MicrosoftSqlserverConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MicrosoftSqlserverConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m MicrosoftSqlserverConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MicrosoftSqlserverConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MicrosoftSqlserverConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MicrosoftSqlserverConnectionSummary) GetId() *string
GetId returns Id
func (m MicrosoftSqlserverConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MicrosoftSqlserverConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m MicrosoftSqlserverConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MicrosoftSqlserverConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MicrosoftSqlserverConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MicrosoftSqlserverConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MicrosoftSqlserverConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MicrosoftSqlserverConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MicrosoftSqlserverConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MicrosoftSqlserverConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MicrosoftSqlserverConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MicrosoftSqlserverConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m MicrosoftSqlserverConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MicrosoftSqlserverConnectionSummary) String() string
func (m MicrosoftSqlserverConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MicrosoftSqlserverConnectionTechnologyTypeEnum Enum with underlying type: string
type MicrosoftSqlserverConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for MicrosoftSqlserverConnectionTechnologyTypeEnum
const (
MicrosoftSqlserverConnectionTechnologyTypeAmazonRdsSqlserver MicrosoftSqlserverConnectionTechnologyTypeEnum = "AMAZON_RDS_SQLSERVER"
MicrosoftSqlserverConnectionTechnologyTypeAzureSqlserverManagedInstance MicrosoftSqlserverConnectionTechnologyTypeEnum = "AZURE_SQLSERVER_MANAGED_INSTANCE"
MicrosoftSqlserverConnectionTechnologyTypeAzureSqlserverNonManagedInstance MicrosoftSqlserverConnectionTechnologyTypeEnum = "AZURE_SQLSERVER_NON_MANAGED_INSTANCE"
MicrosoftSqlserverConnectionTechnologyTypeGoogleCloudSqlSqlserver MicrosoftSqlserverConnectionTechnologyTypeEnum = "GOOGLE_CLOUD_SQL_SQLSERVER"
MicrosoftSqlserverConnectionTechnologyTypeMicrosoftSqlserver MicrosoftSqlserverConnectionTechnologyTypeEnum = "MICROSOFT_SQLSERVER"
)
func GetMappingMicrosoftSqlserverConnectionTechnologyTypeEnum(val string) (MicrosoftSqlserverConnectionTechnologyTypeEnum, bool)
GetMappingMicrosoftSqlserverConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMicrosoftSqlserverConnectionTechnologyTypeEnumValues() []MicrosoftSqlserverConnectionTechnologyTypeEnum
GetMicrosoftSqlserverConnectionTechnologyTypeEnumValues Enumerates the set of values for MicrosoftSqlserverConnectionTechnologyTypeEnum
MongoDbConnection Represents the metadata of a MongoDB Connection.
type MongoDbConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// MongoDB connection string.
// e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The username Oracle GoldenGate uses to connect to the database.
// This username must already exist and be available by the database to be connected to.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection.
// - The content of a .pem file containing the client private key (for 2-way SSL).
// Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
TlsCertificateKeyFileSecretId *string `mandatory:"false" json:"tlsCertificateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file.
// Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
TlsCertificateKeyFilePasswordSecretId *string `mandatory:"false" json:"tlsCertificateKeyFilePasswordSecretId"`
// The MongoDB technology type.
TechnologyType MongoDbConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Protocol for MongoDB.
SecurityProtocol MongoDbConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m MongoDbConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MongoDbConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MongoDbConnection) GetDescription() *string
GetDescription returns Description
func (m MongoDbConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MongoDbConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MongoDbConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MongoDbConnection) GetId() *string
GetId returns Id
func (m MongoDbConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MongoDbConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m MongoDbConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MongoDbConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MongoDbConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MongoDbConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MongoDbConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MongoDbConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MongoDbConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MongoDbConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MongoDbConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MongoDbConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m MongoDbConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MongoDbConnection) String() string
func (m MongoDbConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MongoDbConnectionSecurityProtocolEnum Enum with underlying type: string
type MongoDbConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for MongoDbConnectionSecurityProtocolEnum
const (
MongoDbConnectionSecurityProtocolPlain MongoDbConnectionSecurityProtocolEnum = "PLAIN"
MongoDbConnectionSecurityProtocolTls MongoDbConnectionSecurityProtocolEnum = "TLS"
MongoDbConnectionSecurityProtocolMtls MongoDbConnectionSecurityProtocolEnum = "MTLS"
)
func GetMappingMongoDbConnectionSecurityProtocolEnum(val string) (MongoDbConnectionSecurityProtocolEnum, bool)
GetMappingMongoDbConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMongoDbConnectionSecurityProtocolEnumValues() []MongoDbConnectionSecurityProtocolEnum
GetMongoDbConnectionSecurityProtocolEnumValues Enumerates the set of values for MongoDbConnectionSecurityProtocolEnum
MongoDbConnectionSummary Summary of the MongoDB Connection.
type MongoDbConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// MongoDB connection string.
// e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The username Oracle GoldenGate uses to connect to the database.
// This username must already exist and be available by the database to be connected to.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection.
// - The content of a .pem file containing the client private key (for 2-way SSL).
// Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
TlsCertificateKeyFileSecretId *string `mandatory:"false" json:"tlsCertificateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file.
// Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
TlsCertificateKeyFilePasswordSecretId *string `mandatory:"false" json:"tlsCertificateKeyFilePasswordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The MongoDB technology type.
TechnologyType MongoDbConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for MongoDB.
SecurityProtocol MongoDbConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m MongoDbConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MongoDbConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MongoDbConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m MongoDbConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MongoDbConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MongoDbConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MongoDbConnectionSummary) GetId() *string
GetId returns Id
func (m MongoDbConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MongoDbConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m MongoDbConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MongoDbConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MongoDbConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MongoDbConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MongoDbConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MongoDbConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MongoDbConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MongoDbConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MongoDbConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MongoDbConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m MongoDbConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MongoDbConnectionSummary) String() string
func (m MongoDbConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MongoDbConnectionTechnologyTypeEnum Enum with underlying type: string
type MongoDbConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for MongoDbConnectionTechnologyTypeEnum
const (
MongoDbConnectionTechnologyTypeMongodb MongoDbConnectionTechnologyTypeEnum = "MONGODB"
MongoDbConnectionTechnologyTypeOciAutonomousJsonDatabase MongoDbConnectionTechnologyTypeEnum = "OCI_AUTONOMOUS_JSON_DATABASE"
MongoDbConnectionTechnologyTypeAzureCosmosDbForMongodb MongoDbConnectionTechnologyTypeEnum = "AZURE_COSMOS_DB_FOR_MONGODB"
MongoDbConnectionTechnologyTypeAmazonDocumentDb MongoDbConnectionTechnologyTypeEnum = "AMAZON_DOCUMENT_DB"
MongoDbConnectionTechnologyTypeOracleJsonCollection MongoDbConnectionTechnologyTypeEnum = "ORACLE_JSON_COLLECTION"
)
func GetMappingMongoDbConnectionTechnologyTypeEnum(val string) (MongoDbConnectionTechnologyTypeEnum, bool)
GetMappingMongoDbConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMongoDbConnectionTechnologyTypeEnumValues() []MongoDbConnectionTechnologyTypeEnum
GetMongoDbConnectionTechnologyTypeEnumValues Enumerates the set of values for MongoDbConnectionTechnologyTypeEnum
MysqlConnection Represents the metadata of a MySQL Connection.
type MysqlConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The name of the database.
DatabaseName *string `mandatory:"false" json:"databaseName"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the Client Key
// - The content of a .pem or .crt file containing the client private key (for 2-way SSL).
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// The MySQL technology type.
TechnologyType MysqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Protocol for MySQL.
SecurityProtocol MysqlConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// SSL modes for MySQL.
SslMode MysqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m MysqlConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MysqlConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MysqlConnection) GetDescription() *string
GetDescription returns Description
func (m MysqlConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MysqlConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MysqlConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MysqlConnection) GetId() *string
GetId returns Id
func (m MysqlConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MysqlConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m MysqlConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MysqlConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MysqlConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MysqlConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MysqlConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MysqlConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MysqlConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MysqlConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MysqlConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MysqlConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m MysqlConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MysqlConnection) String() string
func (m MysqlConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MysqlConnectionSecurityProtocolEnum Enum with underlying type: string
type MysqlConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for MysqlConnectionSecurityProtocolEnum
const (
MysqlConnectionSecurityProtocolPlain MysqlConnectionSecurityProtocolEnum = "PLAIN"
MysqlConnectionSecurityProtocolTls MysqlConnectionSecurityProtocolEnum = "TLS"
MysqlConnectionSecurityProtocolMtls MysqlConnectionSecurityProtocolEnum = "MTLS"
)
func GetMappingMysqlConnectionSecurityProtocolEnum(val string) (MysqlConnectionSecurityProtocolEnum, bool)
GetMappingMysqlConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMysqlConnectionSecurityProtocolEnumValues() []MysqlConnectionSecurityProtocolEnum
GetMysqlConnectionSecurityProtocolEnumValues Enumerates the set of values for MysqlConnectionSecurityProtocolEnum
MysqlConnectionSslModeEnum Enum with underlying type: string
type MysqlConnectionSslModeEnum string
Set of constants representing the allowable values for MysqlConnectionSslModeEnum
const (
MysqlConnectionSslModeDisabled MysqlConnectionSslModeEnum = "DISABLED"
MysqlConnectionSslModePreferred MysqlConnectionSslModeEnum = "PREFERRED"
MysqlConnectionSslModeRequired MysqlConnectionSslModeEnum = "REQUIRED"
MysqlConnectionSslModeVerifyCa MysqlConnectionSslModeEnum = "VERIFY_CA"
MysqlConnectionSslModeVerifyIdentity MysqlConnectionSslModeEnum = "VERIFY_IDENTITY"
)
func GetMappingMysqlConnectionSslModeEnum(val string) (MysqlConnectionSslModeEnum, bool)
GetMappingMysqlConnectionSslModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMysqlConnectionSslModeEnumValues() []MysqlConnectionSslModeEnum
GetMysqlConnectionSslModeEnumValues Enumerates the set of values for MysqlConnectionSslModeEnum
MysqlConnectionSummary Summary of the MySQL Connection.
type MysqlConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The name of the database.
DatabaseName *string `mandatory:"false" json:"databaseName"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the Client Key
// - The content of a .pem or .crt file containing the client private key (for 2-way SSL).
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The MySQL technology type.
TechnologyType MysqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security Type for MySQL.
SecurityProtocol MysqlConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// SSL modes for MySQL.
SslMode MysqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
}
func (m MysqlConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m MysqlConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MysqlConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m MysqlConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m MysqlConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m MysqlConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MysqlConnectionSummary) GetId() *string
GetId returns Id
func (m MysqlConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m MysqlConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m MysqlConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m MysqlConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MysqlConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m MysqlConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m MysqlConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m MysqlConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m MysqlConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m MysqlConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MysqlConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MysqlConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m MysqlConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MysqlConnectionSummary) String() string
func (m MysqlConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MysqlConnectionTechnologyTypeEnum Enum with underlying type: string
type MysqlConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for MysqlConnectionTechnologyTypeEnum
const (
MysqlConnectionTechnologyTypeAmazonAuroraMysql MysqlConnectionTechnologyTypeEnum = "AMAZON_AURORA_MYSQL"
MysqlConnectionTechnologyTypeAmazonRdsMariadb MysqlConnectionTechnologyTypeEnum = "AMAZON_RDS_MARIADB"
MysqlConnectionTechnologyTypeAmazonRdsMysql MysqlConnectionTechnologyTypeEnum = "AMAZON_RDS_MYSQL"
MysqlConnectionTechnologyTypeAzureMysql MysqlConnectionTechnologyTypeEnum = "AZURE_MYSQL"
MysqlConnectionTechnologyTypeGoogleCloudSqlMysql MysqlConnectionTechnologyTypeEnum = "GOOGLE_CLOUD_SQL_MYSQL"
MysqlConnectionTechnologyTypeMariadb MysqlConnectionTechnologyTypeEnum = "MARIADB"
MysqlConnectionTechnologyTypeMysqlHeatwaveOnAzure MysqlConnectionTechnologyTypeEnum = "MYSQL_HEATWAVE_ON_AZURE"
MysqlConnectionTechnologyTypeMysqlHeatwaveOnAws MysqlConnectionTechnologyTypeEnum = "MYSQL_HEATWAVE_ON_AWS"
MysqlConnectionTechnologyTypeMysqlServer MysqlConnectionTechnologyTypeEnum = "MYSQL_SERVER"
MysqlConnectionTechnologyTypeOciMysql MysqlConnectionTechnologyTypeEnum = "OCI_MYSQL"
MysqlConnectionTechnologyTypeSinglestoredb MysqlConnectionTechnologyTypeEnum = "SINGLESTOREDB"
MysqlConnectionTechnologyTypeSinglestoredbCloud MysqlConnectionTechnologyTypeEnum = "SINGLESTOREDB_CLOUD"
)
func GetMappingMysqlConnectionTechnologyTypeEnum(val string) (MysqlConnectionTechnologyTypeEnum, bool)
GetMappingMysqlConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMysqlConnectionTechnologyTypeEnumValues() []MysqlConnectionTechnologyTypeEnum
GetMysqlConnectionTechnologyTypeEnumValues Enumerates the set of values for MysqlConnectionTechnologyTypeEnum
NameValuePair A name-value pair representing an attribute entry usable in a list of attributes.
type NameValuePair struct {
// The name of the property entry.
Name *string `mandatory:"true" json:"name"`
// The value of the property entry.
Value *string `mandatory:"true" json:"value"`
}
func (m NameValuePair) String() string
func (m NameValuePair) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OciObjectStorageConnection Represents the metadata of an OCI Object Storage Connection.
type OciObjectStorageConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Object Storage.
// The user must have write access to the bucket they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"true" json:"userId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// The OCI Object Storage technology type.
TechnologyType OciObjectStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m OciObjectStorageConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m OciObjectStorageConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OciObjectStorageConnection) GetDescription() *string
GetDescription returns Description
func (m OciObjectStorageConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m OciObjectStorageConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m OciObjectStorageConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OciObjectStorageConnection) GetId() *string
GetId returns Id
func (m OciObjectStorageConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m OciObjectStorageConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m OciObjectStorageConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m OciObjectStorageConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OciObjectStorageConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m OciObjectStorageConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m OciObjectStorageConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m OciObjectStorageConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m OciObjectStorageConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m OciObjectStorageConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OciObjectStorageConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OciObjectStorageConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m OciObjectStorageConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciObjectStorageConnection) String() string
func (m OciObjectStorageConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OciObjectStorageConnectionSummary Summary of the OCI Object Storage Connection.
type OciObjectStorageConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Object Storage.
// The user must have write access to the bucket they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"true" json:"userId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The OCI Object Storage technology type.
TechnologyType OciObjectStorageConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m OciObjectStorageConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m OciObjectStorageConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OciObjectStorageConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m OciObjectStorageConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m OciObjectStorageConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m OciObjectStorageConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OciObjectStorageConnectionSummary) GetId() *string
GetId returns Id
func (m OciObjectStorageConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m OciObjectStorageConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m OciObjectStorageConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m OciObjectStorageConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OciObjectStorageConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m OciObjectStorageConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m OciObjectStorageConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m OciObjectStorageConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m OciObjectStorageConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m OciObjectStorageConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OciObjectStorageConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OciObjectStorageConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m OciObjectStorageConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciObjectStorageConnectionSummary) String() string
func (m OciObjectStorageConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OciObjectStorageConnectionTechnologyTypeEnum Enum with underlying type: string
type OciObjectStorageConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for OciObjectStorageConnectionTechnologyTypeEnum
const (
OciObjectStorageConnectionTechnologyTypeOciObjectStorage OciObjectStorageConnectionTechnologyTypeEnum = "OCI_OBJECT_STORAGE"
)
func GetMappingOciObjectStorageConnectionTechnologyTypeEnum(val string) (OciObjectStorageConnectionTechnologyTypeEnum, bool)
GetMappingOciObjectStorageConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOciObjectStorageConnectionTechnologyTypeEnumValues() []OciObjectStorageConnectionTechnologyTypeEnum
GetOciObjectStorageConnectionTechnologyTypeEnumValues Enumerates the set of values for OciObjectStorageConnectionTechnologyTypeEnum
OggDeployment Deployment Data for an OggDeployment
type OggDeployment struct {
// The name given to the GoldenGate service deployment.
// The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
DeploymentName *string `mandatory:"true" json:"deploymentName"`
// The GoldenGate deployment console username.
AdminUsername *string `mandatory:"true" json:"adminUsername"`
// Version of OGG
OggVersion *string `mandatory:"false" json:"oggVersion"`
// The base64 encoded content of the PEM file containing the SSL certificate.
Certificate *string `mandatory:"false" json:"certificate"`
// The type of credential store for OGG.
CredentialStore CredentialStoreEnum `mandatory:"false" json:"credentialStore,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.
IdentityDomainId *string `mandatory:"false" json:"identityDomainId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
GroupToRolesMapping *GroupToRolesMappingDetails `mandatory:"false" json:"groupToRolesMapping"`
}
func (m OggDeployment) String() string
func (m OggDeployment) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeGoldengateDatabaseRegistrationCreate OperationTypeEnum = "GOLDENGATE_DATABASE_REGISTRATION_CREATE"
OperationTypeGoldengateDatabaseRegistrationUpdate OperationTypeEnum = "GOLDENGATE_DATABASE_REGISTRATION_UPDATE"
OperationTypeGoldengateDatabaseRegistrationDelete OperationTypeEnum = "GOLDENGATE_DATABASE_REGISTRATION_DELETE"
OperationTypeGoldengateDatabaseRegistrationMove OperationTypeEnum = "GOLDENGATE_DATABASE_REGISTRATION_MOVE"
OperationTypeGoldengateDeploymentCreate OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_CREATE"
OperationTypeGoldengateDeploymentUpdate OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_UPDATE"
OperationTypeGoldengateDeploymentDelete OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_DELETE"
OperationTypeGoldengateDeploymentMove OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_MOVE"
OperationTypeGoldengateDeploymentRestore OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_RESTORE"
OperationTypeGoldengateDeploymentStart OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_START"
OperationTypeGoldengateDeploymentStop OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_STOP"
OperationTypeGoldengateDeploymentUpgrade OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_UPGRADE"
OperationTypeGoldengateDeploymentBackupCreate OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE"
OperationTypeGoldengateDeploymentBackupDelete OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE"
OperationTypeGoldengateDeploymentBackupCancel OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL"
OperationTypeGoldengateDeploymentBackupCopy OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_BACKUP_COPY"
OperationTypeGoldengateConnectionCreate OperationTypeEnum = "GOLDENGATE_CONNECTION_CREATE"
OperationTypeGoldengateConnectionUpdate OperationTypeEnum = "GOLDENGATE_CONNECTION_UPDATE"
OperationTypeGoldengateConnectionDelete OperationTypeEnum = "GOLDENGATE_CONNECTION_DELETE"
OperationTypeGoldengateConnectionMove OperationTypeEnum = "GOLDENGATE_CONNECTION_MOVE"
OperationTypeGoldengateConnectionRefresh OperationTypeEnum = "GOLDENGATE_CONNECTION_REFRESH"
OperationTypeGoldengateConnectionAssignmentCreate OperationTypeEnum = "GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE"
OperationTypeGoldengateConnectionAssignmentDelete OperationTypeEnum = "GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE"
OperationTypeGoldengateConnectionAssigmnentDelete OperationTypeEnum = "GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE"
OperationTypeGoldengateDeploymentDiagnosticCollect OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT"
OperationTypeGoldengateDeploymentWalletExport OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_WALLET_EXPORT"
OperationTypeGoldengateDeploymentWalletImport OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_WALLET_IMPORT"
OperationTypeGoldengateDeploymentUpgradeUpgrade OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE"
OperationTypeGoldengateDeploymentUpgradeRollback OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK"
OperationTypeGoldengateDeploymentUpgradeSnooze OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE"
OperationTypeGoldengateDeploymentCertificateCreate OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE"
OperationTypeGoldengateDeploymentCertificateDelete OperationTypeEnum = "GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE"
OperationTypeGoldengatePipelineCreate OperationTypeEnum = "GOLDENGATE_PIPELINE_CREATE"
OperationTypeGoldengatePipelineStart OperationTypeEnum = "GOLDENGATE_PIPELINE_START"
OperationTypeGoldengatePipelineStop OperationTypeEnum = "GOLDENGATE_PIPELINE_STOP"
OperationTypeGoldengatePipelineUpdate OperationTypeEnum = "GOLDENGATE_PIPELINE_UPDATE"
OperationTypeGoldengatePipelineDelete OperationTypeEnum = "GOLDENGATE_PIPELINE_DELETE"
OperationTypeGoldengatePipelineMove OperationTypeEnum = "GOLDENGATE_PIPELINE_MOVE"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
OracleConnection Represents the metadata of an Oracle Database Connection.
type OracleConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored.
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// Note: When provided, 'wallet' field must not be provided.
WalletSecretId *string `mandatory:"false" json:"walletSecretId"`
// The Oracle technology type.
TechnologyType OracleConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections,
// when a databaseId is provided. The default value is MTLS.
AuthenticationMode OracleConnectionAuthenticationModeEnum `mandatory:"false" json:"authenticationMode,omitempty"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode OracleConnectionSessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m OracleConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m OracleConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OracleConnection) GetDescription() *string
GetDescription returns Description
func (m OracleConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m OracleConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m OracleConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OracleConnection) GetId() *string
GetId returns Id
func (m OracleConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m OracleConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m OracleConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m OracleConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OracleConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m OracleConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m OracleConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m OracleConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m OracleConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m OracleConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OracleConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OracleConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m OracleConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OracleConnection) String() string
func (m OracleConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OracleConnectionAuthenticationModeEnum Enum with underlying type: string
type OracleConnectionAuthenticationModeEnum string
Set of constants representing the allowable values for OracleConnectionAuthenticationModeEnum
const (
OracleConnectionAuthenticationModeTls OracleConnectionAuthenticationModeEnum = "TLS"
OracleConnectionAuthenticationModeMtls OracleConnectionAuthenticationModeEnum = "MTLS"
)
func GetMappingOracleConnectionAuthenticationModeEnum(val string) (OracleConnectionAuthenticationModeEnum, bool)
GetMappingOracleConnectionAuthenticationModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOracleConnectionAuthenticationModeEnumValues() []OracleConnectionAuthenticationModeEnum
GetOracleConnectionAuthenticationModeEnumValues Enumerates the set of values for OracleConnectionAuthenticationModeEnum
OracleConnectionSessionModeEnum Enum with underlying type: string
type OracleConnectionSessionModeEnum string
Set of constants representing the allowable values for OracleConnectionSessionModeEnum
const (
OracleConnectionSessionModeDirect OracleConnectionSessionModeEnum = "DIRECT"
OracleConnectionSessionModeRedirect OracleConnectionSessionModeEnum = "REDIRECT"
)
func GetMappingOracleConnectionSessionModeEnum(val string) (OracleConnectionSessionModeEnum, bool)
GetMappingOracleConnectionSessionModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOracleConnectionSessionModeEnumValues() []OracleConnectionSessionModeEnum
GetOracleConnectionSessionModeEnumValues Enumerates the set of values for OracleConnectionSessionModeEnum
OracleConnectionSummary Summary of the Oracle Connection.
type OracleConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored.
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// Note: When provided, 'wallet' field must not be provided.
WalletSecretId *string `mandatory:"false" json:"walletSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Oracle technology type.
TechnologyType OracleConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections,
// when a databaseId is provided. The default value is MTLS.
AuthenticationMode OracleConnectionAuthenticationModeEnum `mandatory:"false" json:"authenticationMode,omitempty"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode OracleConnectionSessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
}
func (m OracleConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m OracleConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OracleConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m OracleConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m OracleConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m OracleConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OracleConnectionSummary) GetId() *string
GetId returns Id
func (m OracleConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m OracleConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m OracleConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m OracleConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OracleConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m OracleConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m OracleConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m OracleConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m OracleConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m OracleConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OracleConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OracleConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m OracleConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OracleConnectionSummary) String() string
func (m OracleConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OracleConnectionTechnologyTypeEnum Enum with underlying type: string
type OracleConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for OracleConnectionTechnologyTypeEnum
const (
OracleConnectionTechnologyTypeAmazonRdsOracle OracleConnectionTechnologyTypeEnum = "AMAZON_RDS_ORACLE"
OracleConnectionTechnologyTypeOciAutonomousDatabase OracleConnectionTechnologyTypeEnum = "OCI_AUTONOMOUS_DATABASE"
OracleConnectionTechnologyTypeOracleDatabase OracleConnectionTechnologyTypeEnum = "ORACLE_DATABASE"
OracleConnectionTechnologyTypeOracleExadata OracleConnectionTechnologyTypeEnum = "ORACLE_EXADATA"
OracleConnectionTechnologyTypeOracleExadataDatabaseAtAzure OracleConnectionTechnologyTypeEnum = "ORACLE_EXADATA_DATABASE_AT_AZURE"
OracleConnectionTechnologyTypeOracleAutonomousDatabaseAtAzure OracleConnectionTechnologyTypeEnum = "ORACLE_AUTONOMOUS_DATABASE_AT_AZURE"
OracleConnectionTechnologyTypeOracleExadataDatabaseAtGoogleCloud OracleConnectionTechnologyTypeEnum = "ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD"
OracleConnectionTechnologyTypeOracleAutonomousDatabaseAtGoogleCloud OracleConnectionTechnologyTypeEnum = "ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD"
OracleConnectionTechnologyTypeOracleExadataDatabaseAtAws OracleConnectionTechnologyTypeEnum = "ORACLE_EXADATA_DATABASE_AT_AWS"
OracleConnectionTechnologyTypeOracleAutonomousDatabaseAtAws OracleConnectionTechnologyTypeEnum = "ORACLE_AUTONOMOUS_DATABASE_AT_AWS"
)
func GetMappingOracleConnectionTechnologyTypeEnum(val string) (OracleConnectionTechnologyTypeEnum, bool)
GetMappingOracleConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOracleConnectionTechnologyTypeEnumValues() []OracleConnectionTechnologyTypeEnum
GetOracleConnectionTechnologyTypeEnumValues Enumerates the set of values for OracleConnectionTechnologyTypeEnum
OracleNosqlConnection Represents the metadata of an Oracle NoSQL Connection.
type OracleNosqlConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Oracle NoSQL database.
// The user must have write access to the table they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"true" json:"userId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// The Oracle NoSQL technology type.
TechnologyType OracleNosqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m OracleNosqlConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m OracleNosqlConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OracleNosqlConnection) GetDescription() *string
GetDescription returns Description
func (m OracleNosqlConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m OracleNosqlConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m OracleNosqlConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OracleNosqlConnection) GetId() *string
GetId returns Id
func (m OracleNosqlConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m OracleNosqlConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m OracleNosqlConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m OracleNosqlConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OracleNosqlConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m OracleNosqlConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m OracleNosqlConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m OracleNosqlConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m OracleNosqlConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m OracleNosqlConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OracleNosqlConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OracleNosqlConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m OracleNosqlConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OracleNosqlConnection) String() string
func (m OracleNosqlConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OracleNosqlConnectionSummary Summary of the Oracle NoSQL Connection.
type OracleNosqlConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Oracle NoSQL database.
// The user must have write access to the table they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"true" json:"userId"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Oracle NoSQL technology type.
TechnologyType OracleNosqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
}
func (m OracleNosqlConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m OracleNosqlConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OracleNosqlConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m OracleNosqlConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m OracleNosqlConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m OracleNosqlConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OracleNosqlConnectionSummary) GetId() *string
GetId returns Id
func (m OracleNosqlConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m OracleNosqlConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m OracleNosqlConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m OracleNosqlConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OracleNosqlConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m OracleNosqlConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m OracleNosqlConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m OracleNosqlConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m OracleNosqlConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m OracleNosqlConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OracleNosqlConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OracleNosqlConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m OracleNosqlConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OracleNosqlConnectionSummary) String() string
func (m OracleNosqlConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OracleNosqlConnectionTechnologyTypeEnum Enum with underlying type: string
type OracleNosqlConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for OracleNosqlConnectionTechnologyTypeEnum
const (
OracleNosqlConnectionTechnologyTypeOracleNosql OracleNosqlConnectionTechnologyTypeEnum = "ORACLE_NOSQL"
)
func GetMappingOracleNosqlConnectionTechnologyTypeEnum(val string) (OracleNosqlConnectionTechnologyTypeEnum, bool)
GetMappingOracleNosqlConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOracleNosqlConnectionTechnologyTypeEnumValues() []OracleNosqlConnectionTechnologyTypeEnum
GetOracleNosqlConnectionTechnologyTypeEnumValues Enumerates the set of values for OracleNosqlConnectionTechnologyTypeEnum
Pipeline Represents the metadata details of a pipeline in the same compartment.
type Pipeline interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.
GetId() *string
// An object's Display Name.
GetDisplayName() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
GetCompartmentId() *string
// The Oracle license model that applies to a Deployment.
GetLicenseModel() LicenseModelEnum
// The Minimum number of OCPUs to be made available for this Deployment.
GetCpuCoreCount() *int
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
GetIsAutoScalingEnabled() *bool
GetSourceConnectionDetails() *SourcePipelineConnectionDetails
GetTargetConnectionDetails() *TargetPipelineConnectionDetails
// Lifecycle state of the pipeline.
GetLifecycleState() PipelineLifecycleStateEnum
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeCreated() *common.SDKTime
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeUpdated() *common.SDKTime
// Metadata about this specific object.
GetDescription() *string
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
GetSystemTags() map[string]map[string]interface{}
// Locks associated with this resource.
GetLocks() []ResourceLock
// Possible lifecycle substates when retrieving a pipeline.
GetLifecycleSubState() PipelineLifecycleSubStateEnum
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
GetLifecycleDetails() *string
}
PipelineCollection List of pipeline summary objects.
type PipelineCollection struct {
// An array of Pipeline summaries.
Items []PipelineSummary `mandatory:"true" json:"items"`
}
func (m PipelineCollection) String() string
func (m *PipelineCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PipelineCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineInitializationStep The step and its progress based on the recipe type.
type PipelineInitializationStep struct {
// An object's Display Name.
Name *string `mandatory:"true" json:"name"`
// Status of the steps in a recipe. This option applies during pipeline initialization.
Status StepStatusTypeEnum `mandatory:"true" json:"status"`
// Shows the percentage complete of each recipe step during pipeline initialization.
PercentComplete *int `mandatory:"true" json:"percentComplete"`
// The date and time the request was started. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// The date and time the request was finished. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeFinished *common.SDKTime `mandatory:"true" json:"timeFinished"`
// The list of messages for each step while running.
Messages []StepMessage `mandatory:"false" json:"messages"`
}
func (m PipelineInitializationStep) String() string
func (m PipelineInitializationStep) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineInitializationSteps The steps and their progress, based on the recipe type.
type PipelineInitializationSteps struct {
// The sequence of pipeline steps based on the recipe type.
Items []PipelineInitializationStep `mandatory:"true" json:"items"`
}
func (m PipelineInitializationSteps) String() string
func (m PipelineInitializationSteps) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineLifecycleStateEnum Enum with underlying type: string
type PipelineLifecycleStateEnum string
Set of constants representing the allowable values for PipelineLifecycleStateEnum
const (
PipelineLifecycleStateCreating PipelineLifecycleStateEnum = "CREATING"
PipelineLifecycleStateUpdating PipelineLifecycleStateEnum = "UPDATING"
PipelineLifecycleStateActive PipelineLifecycleStateEnum = "ACTIVE"
PipelineLifecycleStateNeedsAttention PipelineLifecycleStateEnum = "NEEDS_ATTENTION"
PipelineLifecycleStateDeleting PipelineLifecycleStateEnum = "DELETING"
PipelineLifecycleStateDeleted PipelineLifecycleStateEnum = "DELETED"
PipelineLifecycleStateFailed PipelineLifecycleStateEnum = "FAILED"
)
func GetMappingPipelineLifecycleStateEnum(val string) (PipelineLifecycleStateEnum, bool)
GetMappingPipelineLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPipelineLifecycleStateEnumValues() []PipelineLifecycleStateEnum
GetPipelineLifecycleStateEnumValues Enumerates the set of values for PipelineLifecycleStateEnum
PipelineLifecycleSubStateEnum Enum with underlying type: string
type PipelineLifecycleSubStateEnum string
Set of constants representing the allowable values for PipelineLifecycleSubStateEnum
const (
PipelineLifecycleSubStateStarting PipelineLifecycleSubStateEnum = "STARTING"
PipelineLifecycleSubStateStopping PipelineLifecycleSubStateEnum = "STOPPING"
PipelineLifecycleSubStateStopped PipelineLifecycleSubStateEnum = "STOPPED"
PipelineLifecycleSubStateMoving PipelineLifecycleSubStateEnum = "MOVING"
PipelineLifecycleSubStateRunning PipelineLifecycleSubStateEnum = "RUNNING"
)
func GetMappingPipelineLifecycleSubStateEnum(val string) (PipelineLifecycleSubStateEnum, bool)
GetMappingPipelineLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPipelineLifecycleSubStateEnumValues() []PipelineLifecycleSubStateEnum
GetPipelineLifecycleSubStateEnumValues Enumerates the set of values for PipelineLifecycleSubStateEnum
PipelineRunningProcessCollection The complete replication process and its details.
type PipelineRunningProcessCollection struct {
// The list of replication processes and their details.
Items []PipelineRunningProcessSummary `mandatory:"true" json:"items"`
}
func (m PipelineRunningProcessCollection) String() string
func (m PipelineRunningProcessCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineRunningProcessSummary Each replication process and their summary details.
type PipelineRunningProcessSummary struct {
// An object's Display Name.
Name *string `mandatory:"true" json:"name"`
// The type of process running in a replication. For example, Extract or Replicat. This option applies when retrieving running processes.
ProcessType ProcessTypeEnum `mandatory:"true" json:"processType"`
// The status of the Extract or Replicat process. This option applies when retrieving running processes.
Status ProcessStatusTypeEnum `mandatory:"true" json:"status"`
// The latency, in seconds, of a process running in a replication. This option applies when retrieving running processes.
LastRecordLagInSeconds *float32 `mandatory:"true" json:"lastRecordLagInSeconds"`
// The date and time the last record was processed by an Extract or Replicat. This option applies when retrieving running processes.
// The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.
TimeLastProcessed *common.SDKTime `mandatory:"true" json:"timeLastProcessed"`
}
func (m PipelineRunningProcessSummary) String() string
func (m PipelineRunningProcessSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineSchemaCollection The list of schemas present in the source/target connection database of a pipeline.
type PipelineSchemaCollection struct {
// Array of pipeline schemas
Items []PipelineSchemaSummary `mandatory:"true" json:"items"`
}
func (m PipelineSchemaCollection) String() string
func (m PipelineSchemaCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineSchemaSummary List of source and target schemas of a pipeline's assigned connection. 1. If there is no explicit mapping defined for the pipeline then only matched source and target schema names will be returned. 2. If there are explicit mappings defined for the pipeline then along with the mapped source and target schema names, the matched source and target schema names also will be returned.
type PipelineSchemaSummary struct {
// The schema name from the database connection.
SourceSchemaName *string `mandatory:"true" json:"sourceSchemaName"`
// The schema name from the database connection.
TargetSchemaName *string `mandatory:"true" json:"targetSchemaName"`
}
func (m PipelineSchemaSummary) String() string
func (m PipelineSchemaSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineSchemaTableCollection List of source or target schema tables of a pipeline's assigned connection.
type PipelineSchemaTableCollection struct {
// Array of source or target schema tables of a pipeline's assigned connection.
Items []PipelineSchemaTableSummary `mandatory:"true" json:"items"`
// The schema name from the database connection.
SourceSchemaName *string `mandatory:"false" json:"sourceSchemaName"`
// The schema name from the database connection.
TargetSchemaName *string `mandatory:"false" json:"targetSchemaName"`
}
func (m PipelineSchemaTableCollection) String() string
func (m PipelineSchemaTableCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineSchemaTableSummary Summary of source or target schema tables of a pipeline's assigned connection. 1. If there is no explicit mapping defined for the pipeline then only matched source and target schema's table names will be returned 2. If there are explicit mappings defined for the pipeline then along with the mapped source and target schema's table names, the matched source and target schema's table names also will be returned.
type PipelineSchemaTableSummary struct {
// The table name from the schema of database connection.
SourceTableName *string `mandatory:"true" json:"sourceTableName"`
// The table name from the schema of database connection.
TargetTableName *string `mandatory:"true" json:"targetTableName"`
}
func (m PipelineSchemaTableSummary) String() string
func (m PipelineSchemaTableSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PipelineSummary Summary details of the pipeline.
type PipelineSummary interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.
GetId() *string
// An object's Display Name.
GetDisplayName() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
GetCompartmentId() *string
GetSourceConnectionDetails() *SourcePipelineConnectionDetails
GetTargetConnectionDetails() *TargetPipelineConnectionDetails
// The Oracle license model that applies to a Deployment.
GetLicenseModel() LicenseModelEnum
// The Minimum number of OCPUs to be made available for this Deployment.
GetCpuCoreCount() *int
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
GetIsAutoScalingEnabled() *bool
// Lifecycle state for the pipeline summary.
GetLifecycleState() PipelineLifecycleStateEnum
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeCreated() *common.SDKTime
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
GetTimeUpdated() *common.SDKTime
// Metadata about this specific object.
GetDescription() *string
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
GetSystemTags() map[string]map[string]interface{}
// Locks associated with this resource.
GetLocks() []ResourceLock
// Possible lifecycle substates when retrieving a pipeline.
GetLifecycleSubState() PipelineLifecycleSubStateEnum
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
GetLifecycleDetails() *string
}
PostgresqlConnection Represents the metadata of a PostgreSQL Database Connection.
type PostgresqlConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt.
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// The PostgreSQL technology type.
TechnologyType PostgresqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for PostgreSQL.
SecurityProtocol PostgresqlConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// SSL mode for PostgreSQL.
SslMode PostgresqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m PostgresqlConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m PostgresqlConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m PostgresqlConnection) GetDescription() *string
GetDescription returns Description
func (m PostgresqlConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m PostgresqlConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m PostgresqlConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m PostgresqlConnection) GetId() *string
GetId returns Id
func (m PostgresqlConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m PostgresqlConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m PostgresqlConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m PostgresqlConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m PostgresqlConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m PostgresqlConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m PostgresqlConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m PostgresqlConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m PostgresqlConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m PostgresqlConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m PostgresqlConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m PostgresqlConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m PostgresqlConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PostgresqlConnection) String() string
func (m PostgresqlConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PostgresqlConnectionSecurityProtocolEnum Enum with underlying type: string
type PostgresqlConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for PostgresqlConnectionSecurityProtocolEnum
const (
PostgresqlConnectionSecurityProtocolPlain PostgresqlConnectionSecurityProtocolEnum = "PLAIN"
PostgresqlConnectionSecurityProtocolTls PostgresqlConnectionSecurityProtocolEnum = "TLS"
PostgresqlConnectionSecurityProtocolMtls PostgresqlConnectionSecurityProtocolEnum = "MTLS"
)
func GetMappingPostgresqlConnectionSecurityProtocolEnum(val string) (PostgresqlConnectionSecurityProtocolEnum, bool)
GetMappingPostgresqlConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPostgresqlConnectionSecurityProtocolEnumValues() []PostgresqlConnectionSecurityProtocolEnum
GetPostgresqlConnectionSecurityProtocolEnumValues Enumerates the set of values for PostgresqlConnectionSecurityProtocolEnum
PostgresqlConnectionSslModeEnum Enum with underlying type: string
type PostgresqlConnectionSslModeEnum string
Set of constants representing the allowable values for PostgresqlConnectionSslModeEnum
const (
PostgresqlConnectionSslModePrefer PostgresqlConnectionSslModeEnum = "PREFER"
PostgresqlConnectionSslModeRequire PostgresqlConnectionSslModeEnum = "REQUIRE"
PostgresqlConnectionSslModeVerifyCa PostgresqlConnectionSslModeEnum = "VERIFY_CA"
PostgresqlConnectionSslModeVerifyFull PostgresqlConnectionSslModeEnum = "VERIFY_FULL"
)
func GetMappingPostgresqlConnectionSslModeEnum(val string) (PostgresqlConnectionSslModeEnum, bool)
GetMappingPostgresqlConnectionSslModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPostgresqlConnectionSslModeEnumValues() []PostgresqlConnectionSslModeEnum
GetPostgresqlConnectionSslModeEnumValues Enumerates the set of values for PostgresqlConnectionSslModeEnum
PostgresqlConnectionSummary Summary of the PostgreSQL Database Connection.
type PostgresqlConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The name of the database.
DatabaseName *string `mandatory:"true" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"true" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"true" json:"port"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"true" json:"username"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt.
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The PostgreSQL technology type.
TechnologyType PostgresqlConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for PostgreSQL.
SecurityProtocol PostgresqlConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// SSL modes for PostgreSQL.
SslMode PostgresqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
}
func (m PostgresqlConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m PostgresqlConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m PostgresqlConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m PostgresqlConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m PostgresqlConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m PostgresqlConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m PostgresqlConnectionSummary) GetId() *string
GetId returns Id
func (m PostgresqlConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m PostgresqlConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m PostgresqlConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m PostgresqlConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m PostgresqlConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m PostgresqlConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m PostgresqlConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m PostgresqlConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m PostgresqlConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m PostgresqlConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m PostgresqlConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m PostgresqlConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m PostgresqlConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PostgresqlConnectionSummary) String() string
func (m PostgresqlConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PostgresqlConnectionTechnologyTypeEnum Enum with underlying type: string
type PostgresqlConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for PostgresqlConnectionTechnologyTypeEnum
const (
PostgresqlConnectionTechnologyTypeOciPostgresql PostgresqlConnectionTechnologyTypeEnum = "OCI_POSTGRESQL"
PostgresqlConnectionTechnologyTypePostgresqlServer PostgresqlConnectionTechnologyTypeEnum = "POSTGRESQL_SERVER"
PostgresqlConnectionTechnologyTypeAmazonAuroraPostgresql PostgresqlConnectionTechnologyTypeEnum = "AMAZON_AURORA_POSTGRESQL"
PostgresqlConnectionTechnologyTypeAmazonRdsPostgresql PostgresqlConnectionTechnologyTypeEnum = "AMAZON_RDS_POSTGRESQL"
PostgresqlConnectionTechnologyTypeAzurePostgresql PostgresqlConnectionTechnologyTypeEnum = "AZURE_POSTGRESQL"
PostgresqlConnectionTechnologyTypeAzureCosmosDbForPostgresql PostgresqlConnectionTechnologyTypeEnum = "AZURE_COSMOS_DB_FOR_POSTGRESQL"
PostgresqlConnectionTechnologyTypeGoogleCloudSqlPostgresql PostgresqlConnectionTechnologyTypeEnum = "GOOGLE_CLOUD_SQL_POSTGRESQL"
PostgresqlConnectionTechnologyTypeGoogleAlloyDbForPostgresql PostgresqlConnectionTechnologyTypeEnum = "GOOGLE_ALLOY_DB_FOR_POSTGRESQL"
)
func GetMappingPostgresqlConnectionTechnologyTypeEnum(val string) (PostgresqlConnectionTechnologyTypeEnum, bool)
GetMappingPostgresqlConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPostgresqlConnectionTechnologyTypeEnumValues() []PostgresqlConnectionTechnologyTypeEnum
GetPostgresqlConnectionTechnologyTypeEnumValues Enumerates the set of values for PostgresqlConnectionTechnologyTypeEnum
ProcessOptions Required pipeline options to configure the replication process (Extract or Replicat).
type ProcessOptions struct {
InitialDataLoad *InitialDataLoad `mandatory:"true" json:"initialDataLoad"`
ReplicateSchemaChange *ReplicateSchemaChange `mandatory:"true" json:"replicateSchemaChange"`
// If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
ShouldRestartOnFailure ProcessOptionsShouldRestartOnFailureEnum `mandatory:"true" json:"shouldRestartOnFailure"`
}
func (m ProcessOptions) String() string
func (m ProcessOptions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProcessOptionsShouldRestartOnFailureEnum Enum with underlying type: string
type ProcessOptionsShouldRestartOnFailureEnum string
Set of constants representing the allowable values for ProcessOptionsShouldRestartOnFailureEnum
const (
ProcessOptionsShouldRestartOnFailureEnabled ProcessOptionsShouldRestartOnFailureEnum = "ENABLED"
ProcessOptionsShouldRestartOnFailureDisabled ProcessOptionsShouldRestartOnFailureEnum = "DISABLED"
)
func GetMappingProcessOptionsShouldRestartOnFailureEnum(val string) (ProcessOptionsShouldRestartOnFailureEnum, bool)
GetMappingProcessOptionsShouldRestartOnFailureEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProcessOptionsShouldRestartOnFailureEnumValues() []ProcessOptionsShouldRestartOnFailureEnum
GetProcessOptionsShouldRestartOnFailureEnumValues Enumerates the set of values for ProcessOptionsShouldRestartOnFailureEnum
ProcessStatusTypeEnum Enum with underlying type: string
type ProcessStatusTypeEnum string
Set of constants representing the allowable values for ProcessStatusTypeEnum
const (
ProcessStatusTypeStopped ProcessStatusTypeEnum = "STOPPED"
ProcessStatusTypeRunning ProcessStatusTypeEnum = "RUNNING"
ProcessStatusTypeError ProcessStatusTypeEnum = "ERROR"
)
func GetMappingProcessStatusTypeEnum(val string) (ProcessStatusTypeEnum, bool)
GetMappingProcessStatusTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProcessStatusTypeEnumValues() []ProcessStatusTypeEnum
GetProcessStatusTypeEnumValues Enumerates the set of values for ProcessStatusTypeEnum
ProcessTypeEnum Enum with underlying type: string
type ProcessTypeEnum string
Set of constants representing the allowable values for ProcessTypeEnum
const (
ProcessTypeExtract ProcessTypeEnum = "EXTRACT"
ProcessTypeReplicat ProcessTypeEnum = "REPLICAT"
)
func GetMappingProcessTypeEnum(val string) (ProcessTypeEnum, bool)
GetMappingProcessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProcessTypeEnumValues() []ProcessTypeEnum
GetProcessTypeEnumValues Enumerates the set of values for ProcessTypeEnum
RecipeSummary The list of recipe details to create pipelines.
type RecipeSummary struct {
// The type of the recipe
RecipeType RecipeTypeEnum `mandatory:"true" json:"recipeType"`
// An object's Display Name.
Name *string `mandatory:"true" json:"name"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Array of supported technology types for this recipe.
SupportedSourceTechnologyTypes []TechnologyTypeEnum `mandatory:"true" json:"supportedSourceTechnologyTypes"`
// Array of supported technology types for this recipe.
SupportedTargetTechnologyTypes []TechnologyTypeEnum `mandatory:"true" json:"supportedTargetTechnologyTypes"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
}
func (m RecipeSummary) String() string
func (m RecipeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecipeSummaryCollection The list of Recipe objects.
type RecipeSummaryCollection struct {
// Array of Recipe Summary
Items []RecipeSummary `mandatory:"true" json:"items"`
}
func (m RecipeSummaryCollection) String() string
func (m RecipeSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecipeTypeEnum Enum with underlying type: string
type RecipeTypeEnum string
Set of constants representing the allowable values for RecipeTypeEnum
const (
RecipeTypeZeroEtl RecipeTypeEnum = "ZERO_ETL"
)
func GetMappingRecipeTypeEnum(val string) (RecipeTypeEnum, bool)
GetMappingRecipeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecipeTypeEnumValues() []RecipeTypeEnum
GetRecipeTypeEnumValues Enumerates the set of values for RecipeTypeEnum
RedisConnection Represents the metadata of a Redis Database Connection.
type RedisConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 6379.
// Used for establishing the initial connection to the Redis cluster.
// Example: `"server1.example.com:6379,server2.example.com:6379"`
Servers *string `mandatory:"true" json:"servers"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Redis cluster.
RedisClusterId *string `mandatory:"false" json:"redisClusterId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The Redis technology type.
TechnologyType RedisConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Redis
SecurityProtocol RedisConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Authentication type for Redis.
AuthenticationType RedisConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m RedisConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m RedisConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m RedisConnection) GetDescription() *string
GetDescription returns Description
func (m RedisConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m RedisConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m RedisConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m RedisConnection) GetId() *string
GetId returns Id
func (m RedisConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m RedisConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m RedisConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m RedisConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m RedisConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m RedisConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m RedisConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m RedisConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m RedisConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m RedisConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m RedisConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m RedisConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m RedisConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RedisConnection) String() string
func (m RedisConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RedisConnectionAuthenticationTypeEnum Enum with underlying type: string
type RedisConnectionAuthenticationTypeEnum string
Set of constants representing the allowable values for RedisConnectionAuthenticationTypeEnum
const (
RedisConnectionAuthenticationTypeNone RedisConnectionAuthenticationTypeEnum = "NONE"
RedisConnectionAuthenticationTypeBasic RedisConnectionAuthenticationTypeEnum = "BASIC"
)
func GetMappingRedisConnectionAuthenticationTypeEnum(val string) (RedisConnectionAuthenticationTypeEnum, bool)
GetMappingRedisConnectionAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRedisConnectionAuthenticationTypeEnumValues() []RedisConnectionAuthenticationTypeEnum
GetRedisConnectionAuthenticationTypeEnumValues Enumerates the set of values for RedisConnectionAuthenticationTypeEnum
RedisConnectionSecurityProtocolEnum Enum with underlying type: string
type RedisConnectionSecurityProtocolEnum string
Set of constants representing the allowable values for RedisConnectionSecurityProtocolEnum
const (
RedisConnectionSecurityProtocolPlain RedisConnectionSecurityProtocolEnum = "PLAIN"
RedisConnectionSecurityProtocolTls RedisConnectionSecurityProtocolEnum = "TLS"
RedisConnectionSecurityProtocolMtls RedisConnectionSecurityProtocolEnum = "MTLS"
)
func GetMappingRedisConnectionSecurityProtocolEnum(val string) (RedisConnectionSecurityProtocolEnum, bool)
GetMappingRedisConnectionSecurityProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRedisConnectionSecurityProtocolEnumValues() []RedisConnectionSecurityProtocolEnum
GetRedisConnectionSecurityProtocolEnumValues Enumerates the set of values for RedisConnectionSecurityProtocolEnum
RedisConnectionSummary Summary of the Redis Database Connection.
type RedisConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 6379.
// Used for establishing the initial connection to the Redis cluster.
// Example: `"server1.example.com:6379,server2.example.com:6379"`
Servers *string `mandatory:"true" json:"servers"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Redis cluster.
RedisClusterId *string `mandatory:"false" json:"redisClusterId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Redis technology type.
TechnologyType RedisConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Security protocol for Redis.
SecurityProtocol RedisConnectionSecurityProtocolEnum `mandatory:"true" json:"securityProtocol"`
// Authenticationentication type for the Redis database.
AuthenticationType RedisConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m RedisConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m RedisConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m RedisConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m RedisConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m RedisConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m RedisConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m RedisConnectionSummary) GetId() *string
GetId returns Id
func (m RedisConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m RedisConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m RedisConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m RedisConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m RedisConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m RedisConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m RedisConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m RedisConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m RedisConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m RedisConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m RedisConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m RedisConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m RedisConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RedisConnectionSummary) String() string
func (m RedisConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RedisConnectionTechnologyTypeEnum Enum with underlying type: string
type RedisConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for RedisConnectionTechnologyTypeEnum
const (
RedisConnectionTechnologyTypeRedis RedisConnectionTechnologyTypeEnum = "REDIS"
RedisConnectionTechnologyTypeOciCacheWithRedis RedisConnectionTechnologyTypeEnum = "OCI_CACHE_WITH_REDIS"
)
func GetMappingRedisConnectionTechnologyTypeEnum(val string) (RedisConnectionTechnologyTypeEnum, bool)
GetMappingRedisConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRedisConnectionTechnologyTypeEnumValues() []RedisConnectionTechnologyTypeEnum
GetRedisConnectionTechnologyTypeEnumValues Enumerates the set of values for RedisConnectionTechnologyTypeEnum
RefreshConnectionDetails The information about the Refresh Connection external attributes.
type RefreshConnectionDetails interface {
}
RefreshConnectionRequest wrapper for the RefreshConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RefreshConnection.go.html to see an example of how to use RefreshConnectionRequest.
type RefreshConnectionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Connection.
ConnectionId *string `mandatory:"true" contributesTo:"path" name:"connectionId"`
// Details of refresh external Connection attributes.
RefreshConnectionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RefreshConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RefreshConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RefreshConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RefreshConnectionRequest) String() string
func (request RefreshConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RefreshConnectionResponse wrapper for the RefreshConnection operation
type RefreshConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RefreshConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RefreshConnectionResponse) String() string
RefreshConnectionTypeEnum Enum with underlying type: string
type RefreshConnectionTypeEnum string
Set of constants representing the allowable values for RefreshConnectionTypeEnum
const (
RefreshConnectionTypeDefault RefreshConnectionTypeEnum = "DEFAULT"
)
func GetMappingRefreshConnectionTypeEnum(val string) (RefreshConnectionTypeEnum, bool)
GetMappingRefreshConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRefreshConnectionTypeEnumValues() []RefreshConnectionTypeEnum
GetRefreshConnectionTypeEnumValues Enumerates the set of values for RefreshConnectionTypeEnum
ReleaseTypeEnum Enum with underlying type: string
type ReleaseTypeEnum string
Set of constants representing the allowable values for ReleaseTypeEnum
const (
ReleaseTypeMajor ReleaseTypeEnum = "MAJOR"
ReleaseTypeBundle ReleaseTypeEnum = "BUNDLE"
ReleaseTypeMinor ReleaseTypeEnum = "MINOR"
)
func GetMappingReleaseTypeEnum(val string) (ReleaseTypeEnum, bool)
GetMappingReleaseTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReleaseTypeEnumValues() []ReleaseTypeEnum
GetReleaseTypeEnumValues Enumerates the set of values for ReleaseTypeEnum
RemoveConnectionLockRequest wrapper for the RemoveConnectionLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RemoveConnectionLock.go.html to see an example of how to use RemoveConnectionLockRequest.
type RemoveConnectionLockRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Connection.
ConnectionId *string `mandatory:"true" contributesTo:"path" name:"connectionId"`
// RemoveResourceLockDetails body parameter
RemoveResourceLockDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RemoveConnectionLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveConnectionLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveConnectionLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveConnectionLockRequest) String() string
func (request RemoveConnectionLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveConnectionLockResponse wrapper for the RemoveConnectionLock operation
type RemoveConnectionLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Connection instance
Connection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// etag for the returned Connection resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RemoveConnectionLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveConnectionLockResponse) String() string
RemoveDeploymentBackupLockRequest wrapper for the RemoveDeploymentBackupLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RemoveDeploymentBackupLock.go.html to see an example of how to use RemoveDeploymentBackupLockRequest.
type RemoveDeploymentBackupLockRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// RemoveResourceLockDetails body parameter
RemoveResourceLockDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RemoveDeploymentBackupLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveDeploymentBackupLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveDeploymentBackupLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveDeploymentBackupLockRequest) String() string
func (request RemoveDeploymentBackupLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveDeploymentBackupLockResponse wrapper for the RemoveDeploymentBackupLock operation
type RemoveDeploymentBackupLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentBackup instance
DeploymentBackup `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// etag for the returned DeploymentBackup resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RemoveDeploymentBackupLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveDeploymentBackupLockResponse) String() string
RemoveDeploymentLockRequest wrapper for the RemoveDeploymentLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RemoveDeploymentLock.go.html to see an example of how to use RemoveDeploymentLockRequest.
type RemoveDeploymentLockRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// RemoveResourceLockDetails body parameter
RemoveResourceLockDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RemoveDeploymentLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveDeploymentLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveDeploymentLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveDeploymentLockRequest) String() string
func (request RemoveDeploymentLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveDeploymentLockResponse wrapper for the RemoveDeploymentLock operation
type RemoveDeploymentLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Deployment instance
Deployment `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// etag for the returned Deployment resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RemoveDeploymentLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveDeploymentLockResponse) String() string
RemoveResourceLockDetails Used to remove a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.
type RemoveResourceLockDetails struct {
// Type of the lock.
Type RemoveResourceLockDetailsTypeEnum `mandatory:"true" json:"type"`
}
func (m RemoveResourceLockDetails) String() string
func (m RemoveResourceLockDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveResourceLockDetailsTypeEnum Enum with underlying type: string
type RemoveResourceLockDetailsTypeEnum string
Set of constants representing the allowable values for RemoveResourceLockDetailsTypeEnum
const (
RemoveResourceLockDetailsTypeFull RemoveResourceLockDetailsTypeEnum = "FULL"
RemoveResourceLockDetailsTypeDelete RemoveResourceLockDetailsTypeEnum = "DELETE"
)
func GetMappingRemoveResourceLockDetailsTypeEnum(val string) (RemoveResourceLockDetailsTypeEnum, bool)
GetMappingRemoveResourceLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRemoveResourceLockDetailsTypeEnumValues() []RemoveResourceLockDetailsTypeEnum
GetRemoveResourceLockDetailsTypeEnumValues Enumerates the set of values for RemoveResourceLockDetailsTypeEnum
ReplicateDdlErrorActionEnum Enum with underlying type: string
type ReplicateDdlErrorActionEnum string
Set of constants representing the allowable values for ReplicateDdlErrorActionEnum
const (
ReplicateDdlErrorActionTerminate ReplicateDdlErrorActionEnum = "TERMINATE"
ReplicateDdlErrorActionDiscard ReplicateDdlErrorActionEnum = "DISCARD"
ReplicateDdlErrorActionIgnore ReplicateDdlErrorActionEnum = "IGNORE"
)
func GetMappingReplicateDdlErrorActionEnum(val string) (ReplicateDdlErrorActionEnum, bool)
GetMappingReplicateDdlErrorActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicateDdlErrorActionEnumValues() []ReplicateDdlErrorActionEnum
GetReplicateDdlErrorActionEnumValues Enumerates the set of values for ReplicateDdlErrorActionEnum
ReplicateDmlErrorActionEnum Enum with underlying type: string
type ReplicateDmlErrorActionEnum string
Set of constants representing the allowable values for ReplicateDmlErrorActionEnum
const (
ReplicateDmlErrorActionTerminate ReplicateDmlErrorActionEnum = "TERMINATE"
ReplicateDmlErrorActionDiscard ReplicateDmlErrorActionEnum = "DISCARD"
ReplicateDmlErrorActionIgnore ReplicateDmlErrorActionEnum = "IGNORE"
)
func GetMappingReplicateDmlErrorActionEnum(val string) (ReplicateDmlErrorActionEnum, bool)
GetMappingReplicateDmlErrorActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicateDmlErrorActionEnumValues() []ReplicateDmlErrorActionEnum
GetReplicateDmlErrorActionEnumValues Enumerates the set of values for ReplicateDmlErrorActionEnum
ReplicateSchemaChange Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
type ReplicateSchemaChange struct {
// If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.
CanReplicateSchemaChange ReplicateSchemaChangeCanReplicateSchemaChangeEnum `mandatory:"true" json:"canReplicateSchemaChange"`
// Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
ActionOnDdlError ReplicateDdlErrorActionEnum `mandatory:"false" json:"actionOnDdlError,omitempty"`
// Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
ActionOnDmlError ReplicateDmlErrorActionEnum `mandatory:"false" json:"actionOnDmlError,omitempty"`
}
func (m ReplicateSchemaChange) String() string
func (m ReplicateSchemaChange) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReplicateSchemaChangeCanReplicateSchemaChangeEnum Enum with underlying type: string
type ReplicateSchemaChangeCanReplicateSchemaChangeEnum string
Set of constants representing the allowable values for ReplicateSchemaChangeCanReplicateSchemaChangeEnum
const (
ReplicateSchemaChangeCanReplicateSchemaChangeEnabled ReplicateSchemaChangeCanReplicateSchemaChangeEnum = "ENABLED"
ReplicateSchemaChangeCanReplicateSchemaChangeDisabled ReplicateSchemaChangeCanReplicateSchemaChangeEnum = "DISABLED"
)
func GetMappingReplicateSchemaChangeCanReplicateSchemaChangeEnum(val string) (ReplicateSchemaChangeCanReplicateSchemaChangeEnum, bool)
GetMappingReplicateSchemaChangeCanReplicateSchemaChangeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicateSchemaChangeCanReplicateSchemaChangeEnumValues() []ReplicateSchemaChangeCanReplicateSchemaChangeEnum
GetReplicateSchemaChangeCanReplicateSchemaChangeEnumValues Enumerates the set of values for ReplicateSchemaChangeCanReplicateSchemaChangeEnum
RescheduleDeploymentUpgradeDetails The information about canceling.
type RescheduleDeploymentUpgradeDetails interface {
}
RescheduleDeploymentUpgradeRequest wrapper for the RescheduleDeploymentUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RescheduleDeploymentUpgrade.go.html to see an example of how to use RescheduleDeploymentUpgradeRequest.
type RescheduleDeploymentUpgradeRequest struct {
// A unique Deployment Upgrade identifier.
DeploymentUpgradeId *string `mandatory:"true" contributesTo:"path" name:"deploymentUpgradeId"`
// Properties to reschedule DeploymentUpgrade.
RescheduleDeploymentUpgradeDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RescheduleDeploymentUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RescheduleDeploymentUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RescheduleDeploymentUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RescheduleDeploymentUpgradeRequest) String() string
func (request RescheduleDeploymentUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RescheduleDeploymentUpgradeResponse wrapper for the RescheduleDeploymentUpgrade operation
type RescheduleDeploymentUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentUpgrade instance
DeploymentUpgrade `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RescheduleDeploymentUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RescheduleDeploymentUpgradeResponse) String() string
RescheduleDeploymentUpgradeToDateDetails Definition of the additional attributes for default deployment upgrade cancel.
type RescheduleDeploymentUpgradeToDateDetails struct {
// The time of upgrade schedule. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeSchedule *common.SDKTime `mandatory:"true" json:"timeSchedule"`
}
func (m RescheduleDeploymentUpgradeToDateDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RescheduleDeploymentUpgradeToDateDetails) String() string
func (m RescheduleDeploymentUpgradeToDateDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RescheduleDeploymentUpgradeTypeEnum Enum with underlying type: string
type RescheduleDeploymentUpgradeTypeEnum string
Set of constants representing the allowable values for RescheduleDeploymentUpgradeTypeEnum
const (
RescheduleDeploymentUpgradeTypeRescheduleToDate RescheduleDeploymentUpgradeTypeEnum = "RESCHEDULE_TO_DATE"
)
func GetMappingRescheduleDeploymentUpgradeTypeEnum(val string) (RescheduleDeploymentUpgradeTypeEnum, bool)
GetMappingRescheduleDeploymentUpgradeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRescheduleDeploymentUpgradeTypeEnumValues() []RescheduleDeploymentUpgradeTypeEnum
GetRescheduleDeploymentUpgradeTypeEnumValues Enumerates the set of values for RescheduleDeploymentUpgradeTypeEnum
ResourceLock Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.
type ResourceLock struct {
// Type of the lock.
Type ResourceLockTypeEnum `mandatory:"true" json:"type"`
// The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// A message added by the creator of the lock. This is typically used to give an
// indication of why the resource is locked.
Message *string `mandatory:"false" json:"message"`
// When the lock was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m ResourceLock) String() string
func (m ResourceLock) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResourceLockTypeEnum Enum with underlying type: string
type ResourceLockTypeEnum string
Set of constants representing the allowable values for ResourceLockTypeEnum
const (
ResourceLockTypeFull ResourceLockTypeEnum = "FULL"
ResourceLockTypeDelete ResourceLockTypeEnum = "DELETE"
)
func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)
GetMappingResourceLockTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum
GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum
RestoreDeploymentDetails The information about the Restore for a Deployment.
type RestoreDeploymentDetails interface {
}
RestoreDeploymentRequest wrapper for the RestoreDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RestoreDeployment.go.html to see an example of how to use RestoreDeploymentRequest.
type RestoreDeploymentRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// A placeholder for any additional metadata to describe the deployment restore.
RestoreDeploymentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RestoreDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreDeploymentRequest) String() string
func (request RestoreDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreDeploymentResponse wrapper for the RestoreDeployment operation
type RestoreDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RestoreDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreDeploymentResponse) String() string
RestoreDeploymentTypeEnum Enum with underlying type: string
type RestoreDeploymentTypeEnum string
Set of constants representing the allowable values for RestoreDeploymentTypeEnum
const (
RestoreDeploymentTypeDefault RestoreDeploymentTypeEnum = "DEFAULT"
)
func GetMappingRestoreDeploymentTypeEnum(val string) (RestoreDeploymentTypeEnum, bool)
GetMappingRestoreDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRestoreDeploymentTypeEnumValues() []RestoreDeploymentTypeEnum
GetRestoreDeploymentTypeEnumValues Enumerates the set of values for RestoreDeploymentTypeEnum
RollbackDeploymentUpgradeDetails The information about the rollback of an upgrade.
type RollbackDeploymentUpgradeDetails interface {
}
RollbackDeploymentUpgradeRequest wrapper for the RollbackDeploymentUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/RollbackDeploymentUpgrade.go.html to see an example of how to use RollbackDeploymentUpgradeRequest.
type RollbackDeploymentUpgradeRequest struct {
// A unique Deployment Upgrade identifier.
DeploymentUpgradeId *string `mandatory:"true" contributesTo:"path" name:"deploymentUpgradeId"`
// A placeholder for any additional metadata to describe the deployment rollback.
RollbackDeploymentUpgradeDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RollbackDeploymentUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RollbackDeploymentUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RollbackDeploymentUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RollbackDeploymentUpgradeRequest) String() string
func (request RollbackDeploymentUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RollbackDeploymentUpgradeResponse wrapper for the RollbackDeploymentUpgrade operation
type RollbackDeploymentUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RollbackDeploymentUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RollbackDeploymentUpgradeResponse) String() string
RollbackDeploymentUpgradeTypeEnum Enum with underlying type: string
type RollbackDeploymentUpgradeTypeEnum string
Set of constants representing the allowable values for RollbackDeploymentUpgradeTypeEnum
const (
RollbackDeploymentUpgradeTypeDefault RollbackDeploymentUpgradeTypeEnum = "DEFAULT"
)
func GetMappingRollbackDeploymentUpgradeTypeEnum(val string) (RollbackDeploymentUpgradeTypeEnum, bool)
GetMappingRollbackDeploymentUpgradeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRollbackDeploymentUpgradeTypeEnumValues() []RollbackDeploymentUpgradeTypeEnum
GetRollbackDeploymentUpgradeTypeEnumValues Enumerates the set of values for RollbackDeploymentUpgradeTypeEnum
RoutingMethodEnum Enum with underlying type: string
type RoutingMethodEnum string
Set of constants representing the allowable values for RoutingMethodEnum
const (
RoutingMethodEnum = "SHARED_SERVICE_ENDPOINT"
RoutingMethodEnum = "SHARED_DEPLOYMENT_ENDPOINT"
RoutingMethodDedicatedEndpoint RoutingMethodEnum = "DEDICATED_ENDPOINT"
)
func GetMappingRoutingMethodEnum(val string) (RoutingMethodEnum, bool)
GetMappingRoutingMethodEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoutingMethodEnumValues() []RoutingMethodEnum
GetRoutingMethodEnumValues Enumerates the set of values for RoutingMethodEnum
SeverityTypeEnum Enum with underlying type: string
type SeverityTypeEnum string
Set of constants representing the allowable values for SeverityTypeEnum
const (
SeverityTypeInfo SeverityTypeEnum = "INFO"
SeverityTypeError SeverityTypeEnum = "ERROR"
SeverityTypeWarning SeverityTypeEnum = "WARNING"
)
func GetMappingSeverityTypeEnum(val string) (SeverityTypeEnum, bool)
GetMappingSeverityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSeverityTypeEnumValues() []SeverityTypeEnum
GetSeverityTypeEnumValues Enumerates the set of values for SeverityTypeEnum
SnoozeDeploymentUpgradeDetails The information about the snooze for a deployment.
type SnoozeDeploymentUpgradeDetails interface {
}
SnoozeDeploymentUpgradeRequest wrapper for the SnoozeDeploymentUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/SnoozeDeploymentUpgrade.go.html to see an example of how to use SnoozeDeploymentUpgradeRequest.
type SnoozeDeploymentUpgradeRequest struct {
// A unique Deployment Upgrade identifier.
DeploymentUpgradeId *string `mandatory:"true" contributesTo:"path" name:"deploymentUpgradeId"`
// A placeholder for any additional metadata to describe the snooze of deployment upgrade.
SnoozeDeploymentUpgradeDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request SnoozeDeploymentUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SnoozeDeploymentUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SnoozeDeploymentUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SnoozeDeploymentUpgradeRequest) String() string
func (request SnoozeDeploymentUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SnoozeDeploymentUpgradeResponse wrapper for the SnoozeDeploymentUpgrade operation
type SnoozeDeploymentUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response SnoozeDeploymentUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SnoozeDeploymentUpgradeResponse) String() string
SnoozeDeploymentUpgradeTypeEnum Enum with underlying type: string
type SnoozeDeploymentUpgradeTypeEnum string
Set of constants representing the allowable values for SnoozeDeploymentUpgradeTypeEnum
const (
SnoozeDeploymentUpgradeTypeDefault SnoozeDeploymentUpgradeTypeEnum = "DEFAULT"
)
func GetMappingSnoozeDeploymentUpgradeTypeEnum(val string) (SnoozeDeploymentUpgradeTypeEnum, bool)
GetMappingSnoozeDeploymentUpgradeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnoozeDeploymentUpgradeTypeEnumValues() []SnoozeDeploymentUpgradeTypeEnum
GetSnoozeDeploymentUpgradeTypeEnumValues Enumerates the set of values for SnoozeDeploymentUpgradeTypeEnum
SnowflakeConnection Represents the metadata of a Snowflake Connection.
type SnowflakeConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// JDBC connection URL.
// e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect to Snowflake.
// This username must already exist and be available by Snowflake platform to be connected to.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the private key file.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// The Snowflake technology type.
TechnologyType SnowflakeConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Snowflake.
AuthenticationType SnowflakeConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m SnowflakeConnection) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m SnowflakeConnection) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m SnowflakeConnection) GetDescription() *string
GetDescription returns Description
func (m SnowflakeConnection) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m SnowflakeConnection) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m SnowflakeConnection) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m SnowflakeConnection) GetId() *string
GetId returns Id
func (m SnowflakeConnection) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m SnowflakeConnection) GetKeyId() *string
GetKeyId returns KeyId
func (m SnowflakeConnection) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m SnowflakeConnection) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m SnowflakeConnection) GetLocks() []ResourceLock
GetLocks returns Locks
func (m SnowflakeConnection) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m SnowflakeConnection) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m SnowflakeConnection) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m SnowflakeConnection) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m SnowflakeConnection) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SnowflakeConnection) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m SnowflakeConnection) GetVaultId() *string
GetVaultId returns VaultId
func (m SnowflakeConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SnowflakeConnection) String() string
func (m SnowflakeConnection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SnowflakeConnectionAuthenticationTypeEnum Enum with underlying type: string
type SnowflakeConnectionAuthenticationTypeEnum string
Set of constants representing the allowable values for SnowflakeConnectionAuthenticationTypeEnum
const (
SnowflakeConnectionAuthenticationTypeBasic SnowflakeConnectionAuthenticationTypeEnum = "BASIC"
SnowflakeConnectionAuthenticationTypeKeyPair SnowflakeConnectionAuthenticationTypeEnum = "KEY_PAIR"
)
func GetMappingSnowflakeConnectionAuthenticationTypeEnum(val string) (SnowflakeConnectionAuthenticationTypeEnum, bool)
GetMappingSnowflakeConnectionAuthenticationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnowflakeConnectionAuthenticationTypeEnumValues() []SnowflakeConnectionAuthenticationTypeEnum
GetSnowflakeConnectionAuthenticationTypeEnumValues Enumerates the set of values for SnowflakeConnectionAuthenticationTypeEnum
SnowflakeConnectionSummary Summary of the Snowflake Connection.
type SnowflakeConnectionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// JDBC connection URL.
// e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>'
ConnectionUrl *string `mandatory:"true" json:"connectionUrl"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp.
// Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
IngressIps []IngressIpDetails `mandatory:"false" json:"ingressIps"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect to Snowflake.
// This username must already exist and be available by Snowflake platform to be connected to.
Username *string `mandatory:"false" json:"username"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the private key file.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// Possible lifecycle states for connection.
LifecycleState ConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// The Snowflake technology type.
TechnologyType SnowflakeConnectionTechnologyTypeEnum `mandatory:"true" json:"technologyType"`
// Used authentication mechanism to access Snowflake.
AuthenticationType SnowflakeConnectionAuthenticationTypeEnum `mandatory:"true" json:"authenticationType"`
}
func (m SnowflakeConnectionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m SnowflakeConnectionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m SnowflakeConnectionSummary) GetDescription() *string
GetDescription returns Description
func (m SnowflakeConnectionSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m SnowflakeConnectionSummary) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m SnowflakeConnectionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m SnowflakeConnectionSummary) GetId() *string
GetId returns Id
func (m SnowflakeConnectionSummary) GetIngressIps() []IngressIpDetails
GetIngressIps returns IngressIps
func (m SnowflakeConnectionSummary) GetKeyId() *string
GetKeyId returns KeyId
func (m SnowflakeConnectionSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m SnowflakeConnectionSummary) GetLifecycleState() ConnectionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m SnowflakeConnectionSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m SnowflakeConnectionSummary) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m SnowflakeConnectionSummary) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m SnowflakeConnectionSummary) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m SnowflakeConnectionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m SnowflakeConnectionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SnowflakeConnectionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m SnowflakeConnectionSummary) GetVaultId() *string
GetVaultId returns VaultId
func (m SnowflakeConnectionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SnowflakeConnectionSummary) String() string
func (m SnowflakeConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SnowflakeConnectionTechnologyTypeEnum Enum with underlying type: string
type SnowflakeConnectionTechnologyTypeEnum string
Set of constants representing the allowable values for SnowflakeConnectionTechnologyTypeEnum
const (
SnowflakeConnectionTechnologyTypeSnowflake SnowflakeConnectionTechnologyTypeEnum = "SNOWFLAKE"
)
func GetMappingSnowflakeConnectionTechnologyTypeEnum(val string) (SnowflakeConnectionTechnologyTypeEnum, bool)
GetMappingSnowflakeConnectionTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnowflakeConnectionTechnologyTypeEnumValues() []SnowflakeConnectionTechnologyTypeEnum
GetSnowflakeConnectionTechnologyTypeEnumValues Enumerates the set of values for SnowflakeConnectionTechnologyTypeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
SourcePipelineConnectionDetails The source connection details for creating a pipeline.
type SourcePipelineConnectionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
ConnectionId *string `mandatory:"true" json:"connectionId"`
}
func (m SourcePipelineConnectionDetails) String() string
func (m SourcePipelineConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartDeploymentDetails The information about the Start for a Deployment.
type StartDeploymentDetails interface {
}
StartDeploymentRequest wrapper for the StartDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StartDeployment.go.html to see an example of how to use StartDeploymentRequest.
type StartDeploymentRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A placeholder for any additional metadata to describe the deployment start.
StartDeploymentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StartDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartDeploymentRequest) String() string
func (request StartDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartDeploymentResponse wrapper for the StartDeployment operation
type StartDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StartDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartDeploymentResponse) String() string
StartDeploymentTypeEnum Enum with underlying type: string
type StartDeploymentTypeEnum string
Set of constants representing the allowable values for StartDeploymentTypeEnum
const (
StartDeploymentTypeDefault StartDeploymentTypeEnum = "DEFAULT"
)
func GetMappingStartDeploymentTypeEnum(val string) (StartDeploymentTypeEnum, bool)
GetMappingStartDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStartDeploymentTypeEnumValues() []StartDeploymentTypeEnum
GetStartDeploymentTypeEnumValues Enumerates the set of values for StartDeploymentTypeEnum
StartPipelineDetails Details with which to start a pipeline.
type StartPipelineDetails interface {
}
StartPipelineRequest wrapper for the StartPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StartPipeline.go.html to see an example of how to use StartPipelineRequest.
type StartPipelineRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// Details to start Pipeline.
StartPipelineDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StartPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartPipelineRequest) String() string
func (request StartPipelineRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartPipelineResponse wrapper for the StartPipeline operation
type StartPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StartPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartPipelineResponse) String() string
StartPipelineTypeEnum Enum with underlying type: string
type StartPipelineTypeEnum string
Set of constants representing the allowable values for StartPipelineTypeEnum
const (
StartPipelineTypeDefault StartPipelineTypeEnum = "DEFAULT"
)
func GetMappingStartPipelineTypeEnum(val string) (StartPipelineTypeEnum, bool)
GetMappingStartPipelineTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStartPipelineTypeEnumValues() []StartPipelineTypeEnum
GetStartPipelineTypeEnumValues Enumerates the set of values for StartPipelineTypeEnum
StepMessage Contents of a step message.
type StepMessage struct {
// The status message of the steps in a recipe during pipeline initialization.
// https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html
Message *string `mandatory:"true" json:"message"`
// The code returned when GoldenGate reports an error while running a step during pipeline initialization.
// https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2
Code *string `mandatory:"true" json:"code"`
// Date and time of a message issued by steps in a recipe during pipeline initialization.
// The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization.
// https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html
Severity SeverityTypeEnum `mandatory:"true" json:"severity"`
}
func (m StepMessage) String() string
func (m StepMessage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StepStatusTypeEnum Enum with underlying type: string
type StepStatusTypeEnum string
Set of constants representing the allowable values for StepStatusTypeEnum
const (
StepStatusTypePending StepStatusTypeEnum = "PENDING"
StepStatusTypeInProgress StepStatusTypeEnum = "IN_PROGRESS"
StepStatusTypeCompleted StepStatusTypeEnum = "COMPLETED"
StepStatusTypeFailed StepStatusTypeEnum = "FAILED"
)
func GetMappingStepStatusTypeEnum(val string) (StepStatusTypeEnum, bool)
GetMappingStepStatusTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStepStatusTypeEnumValues() []StepStatusTypeEnum
GetStepStatusTypeEnumValues Enumerates the set of values for StepStatusTypeEnum
StopDeploymentDetails The information about the Stop for a Deployment.
type StopDeploymentDetails interface {
}
StopDeploymentRequest wrapper for the StopDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StopDeployment.go.html to see an example of how to use StopDeploymentRequest.
type StopDeploymentRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A placeholder for any additional metadata to describe the deployment stop.
StopDeploymentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StopDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopDeploymentRequest) String() string
func (request StopDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopDeploymentResponse wrapper for the StopDeployment operation
type StopDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StopDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopDeploymentResponse) String() string
StopDeploymentTypeEnum Enum with underlying type: string
type StopDeploymentTypeEnum string
Set of constants representing the allowable values for StopDeploymentTypeEnum
const (
StopDeploymentTypeDefault StopDeploymentTypeEnum = "DEFAULT"
)
func GetMappingStopDeploymentTypeEnum(val string) (StopDeploymentTypeEnum, bool)
GetMappingStopDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStopDeploymentTypeEnumValues() []StopDeploymentTypeEnum
GetStopDeploymentTypeEnumValues Enumerates the set of values for StopDeploymentTypeEnum
StopPipelineDetails Details for a pipeline stop.
type StopPipelineDetails interface {
}
StopPipelineRequest wrapper for the StopPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/StopPipeline.go.html to see an example of how to use StopPipelineRequest.
type StopPipelineRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// Details to stop the pipeline.
StopPipelineDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StopPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopPipelineRequest) String() string
func (request StopPipelineRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopPipelineResponse wrapper for the StopPipeline operation
type StopPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StopPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopPipelineResponse) String() string
StopPipelineTypeEnum Enum with underlying type: string
type StopPipelineTypeEnum string
Set of constants representing the allowable values for StopPipelineTypeEnum
const (
StopPipelineTypeDefault StopPipelineTypeEnum = "DEFAULT"
)
func GetMappingStopPipelineTypeEnum(val string) (StopPipelineTypeEnum, bool)
GetMappingStopPipelineTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStopPipelineTypeEnumValues() []StopPipelineTypeEnum
GetStopPipelineTypeEnumValues Enumerates the set of values for StopPipelineTypeEnum
TargetPipelineConnectionDetails The target connection details for creating a pipeline.
type TargetPipelineConnectionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being
// referenced.
ConnectionId *string `mandatory:"true" json:"connectionId"`
}
func (m TargetPipelineConnectionDetails) String() string
func (m TargetPipelineConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TechnologyTypeEnum Enum with underlying type: string
type TechnologyTypeEnum string
Set of constants representing the allowable values for TechnologyTypeEnum
const (
TechnologyTypeGoldengate TechnologyTypeEnum = "GOLDENGATE"
TechnologyTypeGeneric TechnologyTypeEnum = "GENERIC"
TechnologyTypeOciAutonomousDatabase TechnologyTypeEnum = "OCI_AUTONOMOUS_DATABASE"
TechnologyTypeOciAutonomousJsonDatabase TechnologyTypeEnum = "OCI_AUTONOMOUS_JSON_DATABASE"
TechnologyTypeOciCacheWithRedis TechnologyTypeEnum = "OCI_CACHE_WITH_REDIS"
TechnologyTypeOciMysql TechnologyTypeEnum = "OCI_MYSQL"
TechnologyTypeOciObjectStorage TechnologyTypeEnum = "OCI_OBJECT_STORAGE"
TechnologyTypeOciPostgresql TechnologyTypeEnum = "OCI_POSTGRESQL"
TechnologyTypeOciStreaming TechnologyTypeEnum = "OCI_STREAMING"
TechnologyTypeOracleDatabase TechnologyTypeEnum = "ORACLE_DATABASE"
TechnologyTypeOracleExadata TechnologyTypeEnum = "ORACLE_EXADATA"
TechnologyTypeOracleExadataDatabaseAtAzure TechnologyTypeEnum = "ORACLE_EXADATA_DATABASE_AT_AZURE"
TechnologyTypeOracleAutonomousDatabaseAtAzure TechnologyTypeEnum = "ORACLE_AUTONOMOUS_DATABASE_AT_AZURE"
TechnologyTypeOracleJsonCollection TechnologyTypeEnum = "ORACLE_JSON_COLLECTION"
TechnologyTypeOracleExadataDatabaseAtGoogleCloud TechnologyTypeEnum = "ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD"
TechnologyTypeOracleAutonomousDatabaseAtGoogleCloud TechnologyTypeEnum = "ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD"
TechnologyTypeOracleExadataDatabaseAtAws TechnologyTypeEnum = "ORACLE_EXADATA_DATABASE_AT_AWS"
TechnologyTypeOracleAutonomousDatabaseAtAws TechnologyTypeEnum = "ORACLE_AUTONOMOUS_DATABASE_AT_AWS"
TechnologyTypeOracleNosql TechnologyTypeEnum = "ORACLE_NOSQL"
TechnologyTypeOracleWeblogicJms TechnologyTypeEnum = "ORACLE_WEBLOGIC_JMS"
TechnologyTypeAmazonRdsOracle TechnologyTypeEnum = "AMAZON_RDS_ORACLE"
TechnologyTypeAmazonRdsSqlserver TechnologyTypeEnum = "AMAZON_RDS_SQLSERVER"
TechnologyTypeAmazonS3 TechnologyTypeEnum = "AMAZON_S3"
TechnologyTypeAmazonAuroraMysql TechnologyTypeEnum = "AMAZON_AURORA_MYSQL"
TechnologyTypeAmazonAuroraPostgresql TechnologyTypeEnum = "AMAZON_AURORA_POSTGRESQL"
TechnologyTypeAmazonDocumentDb TechnologyTypeEnum = "AMAZON_DOCUMENT_DB"
TechnologyTypeAmazonKinesis TechnologyTypeEnum = "AMAZON_KINESIS"
TechnologyTypeAmazonRedshift TechnologyTypeEnum = "AMAZON_REDSHIFT"
TechnologyTypeAmazonRdsMariadb TechnologyTypeEnum = "AMAZON_RDS_MARIADB"
TechnologyTypeAmazonRdsMysql TechnologyTypeEnum = "AMAZON_RDS_MYSQL"
TechnologyTypeAmazonRdsPostgresql TechnologyTypeEnum = "AMAZON_RDS_POSTGRESQL"
TechnologyTypeApacheKafka TechnologyTypeEnum = "APACHE_KAFKA"
TechnologyTypeAzureCosmosDbForMongodb TechnologyTypeEnum = "AZURE_COSMOS_DB_FOR_MONGODB"
TechnologyTypeAzureCosmosDbForPostgresql TechnologyTypeEnum = "AZURE_COSMOS_DB_FOR_POSTGRESQL"
TechnologyTypeAzureDataLakeStorage TechnologyTypeEnum = "AZURE_DATA_LAKE_STORAGE"
TechnologyTypeAzureEventHubs TechnologyTypeEnum = "AZURE_EVENT_HUBS"
TechnologyTypeAzureMysql TechnologyTypeEnum = "AZURE_MYSQL"
TechnologyTypeAzurePostgresql TechnologyTypeEnum = "AZURE_POSTGRESQL"
TechnologyTypeAzureSqlserverManagedInstance TechnologyTypeEnum = "AZURE_SQLSERVER_MANAGED_INSTANCE"
TechnologyTypeAzureSqlserverNonManagedInstance TechnologyTypeEnum = "AZURE_SQLSERVER_NON_MANAGED_INSTANCE"
TechnologyTypeAzureSynapseAnalytics TechnologyTypeEnum = "AZURE_SYNAPSE_ANALYTICS"
TechnologyTypeConfluentKafka TechnologyTypeEnum = "CONFLUENT_KAFKA"
TechnologyTypeConfluentSchemaRegistry TechnologyTypeEnum = "CONFLUENT_SCHEMA_REGISTRY"
TechnologyTypeDatabricks TechnologyTypeEnum = "DATABRICKS"
TechnologyTypeDb2Zos TechnologyTypeEnum = "DB2_ZOS"
TechnologyTypeElasticsearch TechnologyTypeEnum = "ELASTICSEARCH"
TechnologyTypeGoogleAlloyDbForPostgresql TechnologyTypeEnum = "GOOGLE_ALLOY_DB_FOR_POSTGRESQL"
TechnologyTypeGoogleBigquery TechnologyTypeEnum = "GOOGLE_BIGQUERY"
TechnologyTypeGoogleCloudStorage TechnologyTypeEnum = "GOOGLE_CLOUD_STORAGE"
TechnologyTypeGoogleCloudSqlMysql TechnologyTypeEnum = "GOOGLE_CLOUD_SQL_MYSQL"
TechnologyTypeGoogleCloudSqlPostgresql TechnologyTypeEnum = "GOOGLE_CLOUD_SQL_POSTGRESQL"
TechnologyTypeGoogleCloudSqlSqlserver TechnologyTypeEnum = "GOOGLE_CLOUD_SQL_SQLSERVER"
TechnologyTypeGooglePubsub TechnologyTypeEnum = "GOOGLE_PUBSUB"
TechnologyTypeHdfs TechnologyTypeEnum = "HDFS"
TechnologyTypeMariadb TechnologyTypeEnum = "MARIADB"
TechnologyTypeMicrosoftSqlserver TechnologyTypeEnum = "MICROSOFT_SQLSERVER"
TechnologyTypeMicrosoftFabricLakehouse TechnologyTypeEnum = "MICROSOFT_FABRIC_LAKEHOUSE"
TechnologyTypeMicrosoftFabricMirror TechnologyTypeEnum = "MICROSOFT_FABRIC_MIRROR"
TechnologyTypeMongodb TechnologyTypeEnum = "MONGODB"
TechnologyTypeMysqlServer TechnologyTypeEnum = "MYSQL_SERVER"
TechnologyTypeMysqlHeatwaveOnAzure TechnologyTypeEnum = "MYSQL_HEATWAVE_ON_AZURE"
TechnologyTypeMysqlHeatwaveOnAws TechnologyTypeEnum = "MYSQL_HEATWAVE_ON_AWS"
TechnologyTypePostgresqlServer TechnologyTypeEnum = "POSTGRESQL_SERVER"
TechnologyTypeRedis TechnologyTypeEnum = "REDIS"
TechnologyTypeSinglestoredb TechnologyTypeEnum = "SINGLESTOREDB"
TechnologyTypeSinglestoredbCloud TechnologyTypeEnum = "SINGLESTOREDB_CLOUD"
TechnologyTypeSnowflake TechnologyTypeEnum = "SNOWFLAKE"
)
func GetMappingTechnologyTypeEnum(val string) (TechnologyTypeEnum, bool)
GetMappingTechnologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTechnologyTypeEnumValues() []TechnologyTypeEnum
GetTechnologyTypeEnumValues Enumerates the set of values for TechnologyTypeEnum
TestConnectionAssignmentDetails The information about testing the assigned connection.
type TestConnectionAssignmentDetails interface {
}
TestConnectionAssignmentError Error Information.
type TestConnectionAssignmentError struct {
// A short error code that defines the error, meant for programmatic parsing.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// The text describing the root cause of the reported issue.
Issue *string `mandatory:"false" json:"issue"`
// The text describing the action required to fix the issue.
Action *string `mandatory:"false" json:"action"`
}
func (m TestConnectionAssignmentError) String() string
func (m TestConnectionAssignmentError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TestConnectionAssignmentRequest wrapper for the TestConnectionAssignment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/TestConnectionAssignment.go.html to see an example of how to use TestConnectionAssignmentRequest.
type TestConnectionAssignmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Connection Assignment.
ConnectionAssignmentId *string `mandatory:"true" contributesTo:"path" name:"connectionAssignmentId"`
// A placeholder for any additional metadata to describe the requested tests of the assigned connection.
TestConnectionAssignmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request TestConnectionAssignmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request TestConnectionAssignmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request TestConnectionAssignmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request TestConnectionAssignmentRequest) String() string
func (request TestConnectionAssignmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TestConnectionAssignmentResponse wrapper for the TestConnectionAssignment operation
type TestConnectionAssignmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The TestConnectionAssignmentResult instance
TestConnectionAssignmentResult `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response TestConnectionAssignmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response TestConnectionAssignmentResponse) String() string
TestConnectionAssignmentResult The result of the connectivity test performed between the GoldenGate deployment and the associated database / service. The 'error' property is deprecated and will not contain values in the future. So, the error(s) will be returned in just the 'errors' property.
type TestConnectionAssignmentResult struct {
// Type of the result (i.e. Success, Failure or Timeout).
ResultType TestConnectionAssignmentResultResultTypeEnum `mandatory:"true" json:"resultType"`
Error *TestConnectionAssignmentError `mandatory:"false" json:"error"`
// List of test connection assignment error objects.
Errors []TestConnectionAssignmentError `mandatory:"false" json:"errors"`
}
func (m TestConnectionAssignmentResult) String() string
func (m TestConnectionAssignmentResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TestConnectionAssignmentResultResultTypeEnum Enum with underlying type: string
type TestConnectionAssignmentResultResultTypeEnum string
Set of constants representing the allowable values for TestConnectionAssignmentResultResultTypeEnum
const (
TestConnectionAssignmentResultResultTypeSucceeded TestConnectionAssignmentResultResultTypeEnum = "SUCCEEDED"
TestConnectionAssignmentResultResultTypeFailed TestConnectionAssignmentResultResultTypeEnum = "FAILED"
TestConnectionAssignmentResultResultTypeTimedOut TestConnectionAssignmentResultResultTypeEnum = "TIMED_OUT"
)
func GetMappingTestConnectionAssignmentResultResultTypeEnum(val string) (TestConnectionAssignmentResultResultTypeEnum, bool)
GetMappingTestConnectionAssignmentResultResultTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTestConnectionAssignmentResultResultTypeEnumValues() []TestConnectionAssignmentResultResultTypeEnum
GetTestConnectionAssignmentResultResultTypeEnumValues Enumerates the set of values for TestConnectionAssignmentResultResultTypeEnum
TestConnectionAssignmentTypeEnum Enum with underlying type: string
type TestConnectionAssignmentTypeEnum string
Set of constants representing the allowable values for TestConnectionAssignmentTypeEnum
const (
TestConnectionAssignmentTypeDefault TestConnectionAssignmentTypeEnum = "DEFAULT"
)
func GetMappingTestConnectionAssignmentTypeEnum(val string) (TestConnectionAssignmentTypeEnum, bool)
GetMappingTestConnectionAssignmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTestConnectionAssignmentTypeEnumValues() []TestConnectionAssignmentTypeEnum
GetTestConnectionAssignmentTypeEnumValues Enumerates the set of values for TestConnectionAssignmentTypeEnum
TestPipelineConnectionDetails Details about testing the pipeline's assigned connection.
type TestPipelineConnectionDetails interface {
}
TestPipelineConnectionError The error returned when a pipeline connection fails to connect.
type TestPipelineConnectionError struct {
// A short error code that defines the error, meant for programmatic parsing.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// The text describing the root cause of the reported issue.
Issue *string `mandatory:"false" json:"issue"`
// The text describing the action required to fix the issue.
Action *string `mandatory:"false" json:"action"`
}
func (m TestPipelineConnectionError) String() string
func (m TestPipelineConnectionError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TestPipelineConnectionRequest wrapper for the TestPipelineConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/TestPipelineConnection.go.html to see an example of how to use TestPipelineConnectionRequest.
type TestPipelineConnectionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// Additional metadata required to test the connection assigned to the pipeline.
TestPipelineConnectionDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request TestPipelineConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request TestPipelineConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request TestPipelineConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request TestPipelineConnectionRequest) String() string
func (request TestPipelineConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TestPipelineConnectionResponse wrapper for the TestPipelineConnection operation
type TestPipelineConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// The TestPipelineConnectionResult instance
TestPipelineConnectionResult `presentIn:"body"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response TestPipelineConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response TestPipelineConnectionResponse) String() string
TestPipelineConnectionResult Result of the connectivity test performed on a pipeline's assigned connection.
type TestPipelineConnectionResult struct {
// Type of result, either Succeeded, Failed, or Timed out.
ResultType TestPipelineConnectionResultResultTypeEnum `mandatory:"true" json:"resultType"`
Error *TestPipelineConnectionError `mandatory:"false" json:"error"`
}
func (m TestPipelineConnectionResult) String() string
func (m TestPipelineConnectionResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TestPipelineConnectionResultResultTypeEnum Enum with underlying type: string
type TestPipelineConnectionResultResultTypeEnum string
Set of constants representing the allowable values for TestPipelineConnectionResultResultTypeEnum
const (
TestPipelineConnectionResultResultTypeSucceeded TestPipelineConnectionResultResultTypeEnum = "SUCCEEDED"
TestPipelineConnectionResultResultTypeFailed TestPipelineConnectionResultResultTypeEnum = "FAILED"
TestPipelineConnectionResultResultTypeTimedOut TestPipelineConnectionResultResultTypeEnum = "TIMED_OUT"
)
func GetMappingTestPipelineConnectionResultResultTypeEnum(val string) (TestPipelineConnectionResultResultTypeEnum, bool)
GetMappingTestPipelineConnectionResultResultTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTestPipelineConnectionResultResultTypeEnumValues() []TestPipelineConnectionResultResultTypeEnum
GetTestPipelineConnectionResultResultTypeEnumValues Enumerates the set of values for TestPipelineConnectionResultResultTypeEnum
TestPipelineConnectionTypeEnum Enum with underlying type: string
type TestPipelineConnectionTypeEnum string
Set of constants representing the allowable values for TestPipelineConnectionTypeEnum
const (
TestPipelineConnectionTypeDefault TestPipelineConnectionTypeEnum = "DEFAULT"
)
func GetMappingTestPipelineConnectionTypeEnum(val string) (TestPipelineConnectionTypeEnum, bool)
GetMappingTestPipelineConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTestPipelineConnectionTypeEnumValues() []TestPipelineConnectionTypeEnum
GetTestPipelineConnectionTypeEnumValues Enumerates the set of values for TestPipelineConnectionTypeEnum
TrailFileCollection A list of TrailFiles.
type TrailFileCollection struct {
// The time the data was last fetched from the deployment. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeLastFetched *common.SDKTime `mandatory:"true" json:"timeLastFetched"`
// An array of TrailFiles.
Items []TrailFileSummary `mandatory:"true" json:"items"`
}
func (m TrailFileCollection) String() string
func (m TrailFileCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TrailFileSummary Summary of the TrailFiles.
type TrailFileSummary struct {
// The TrailFile Id.
TrailFileId *string `mandatory:"true" json:"trailFileId"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The size of the backup stored in object storage (in bytes)
SizeInBytes *int64 `mandatory:"false" json:"sizeInBytes"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeLastUpdated *common.SDKTime `mandatory:"false" json:"timeLastUpdated"`
// Number of sequences for a specific trail file
NumberOfSequences *int `mandatory:"false" json:"numberOfSequences"`
// Minimum sequence number
MinSequenceNumber *string `mandatory:"false" json:"minSequenceNumber"`
// Maximum sequence number
MaxSequenceNumber *string `mandatory:"false" json:"maxSequenceNumber"`
// Producer Process Name if any.
Producer *string `mandatory:"false" json:"producer"`
// array of consumer process names
Consumers []string `mandatory:"false" json:"consumers"`
}
func (m TrailFileSummary) String() string
func (m TrailFileSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TrailSequenceCollection A list of TrailSequences.
type TrailSequenceCollection struct {
// The time the data was last fetched from the deployment. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeLastFetched *common.SDKTime `mandatory:"true" json:"timeLastFetched"`
// An array of TrailSequences.
Items []TrailSequenceSummary `mandatory:"true" json:"items"`
}
func (m TrailSequenceCollection) String() string
func (m TrailSequenceCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TrailSequenceSummary Summary of the TrailSequences.
type TrailSequenceSummary struct {
// Sequence Id
SequenceId *string `mandatory:"true" json:"sequenceId"`
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The size of the backup stored in object storage (in bytes)
SizeInBytes *int64 `mandatory:"false" json:"sizeInBytes"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeLastUpdated *common.SDKTime `mandatory:"false" json:"timeLastUpdated"`
}
func (m TrailSequenceSummary) String() string
func (m TrailSequenceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAmazonKinesisConnectionDetails The information to update a the Amazon Kinesis Connection.
type UpdateAmazonKinesisConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Access key ID to access the Amazon Kinesis.
AccessKeyId *string `mandatory:"false" json:"accessKeyId"`
// Secret access key to access the Amazon Kinesis.
// Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
SecretAccessKey *string `mandatory:"false" json:"secretAccessKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the secret access key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateAmazonKinesisConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateAmazonKinesisConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateAmazonKinesisConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateAmazonKinesisConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateAmazonKinesisConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateAmazonKinesisConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateAmazonKinesisConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateAmazonKinesisConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateAmazonKinesisConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateAmazonKinesisConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateAmazonKinesisConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAmazonKinesisConnectionDetails) String() string
func (m UpdateAmazonKinesisConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAmazonRedshiftConnectionDetails The information to update a the Amazon Redshift Connection.
type UpdateAmazonRedshiftConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Connection URL.
// e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'
ConnectionUrl *string `mandatory:"false" json:"connectionUrl"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateAmazonRedshiftConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateAmazonRedshiftConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateAmazonRedshiftConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateAmazonRedshiftConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateAmazonRedshiftConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateAmazonRedshiftConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateAmazonRedshiftConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateAmazonRedshiftConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateAmazonRedshiftConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateAmazonRedshiftConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateAmazonRedshiftConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAmazonRedshiftConnectionDetails) String() string
func (m UpdateAmazonRedshiftConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAmazonS3ConnectionDetails The information to update a the Amazon S3 Connection.
type UpdateAmazonS3ConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Access key ID to access the Amazon S3 bucket.
// e.g.: "this-is-not-the-secret"
AccessKeyId *string `mandatory:"false" json:"accessKeyId"`
// Secret access key to access the Amazon S3 bucket.
// e.g.: "this-is-not-the-secret"
// Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
SecretAccessKey *string `mandatory:"false" json:"secretAccessKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.
// Note: When provided, 'secretAccessKey' field must not be provided.
SecretAccessKeySecretId *string `mandatory:"false" json:"secretAccessKeySecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateAmazonS3ConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateAmazonS3ConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateAmazonS3ConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateAmazonS3ConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateAmazonS3ConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateAmazonS3ConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateAmazonS3ConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateAmazonS3ConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateAmazonS3ConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateAmazonS3ConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateAmazonS3ConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAmazonS3ConnectionDetails) String() string
func (m UpdateAmazonS3ConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAzureDataLakeStorageConnectionDetails The information to update a Azure Data Lake Storage Connection.
type UpdateAzureDataLakeStorageConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Sets the Azure storage account name.
AccountName *string `mandatory:"false" json:"accountName"`
// Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'.
// e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==
// Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
AccountKey *string `mandatory:"false" json:"accountKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.
// Note: When provided, 'accountKey' field must not be provided.
AccountKeySecretId *string `mandatory:"false" json:"accountKeySecretId"`
// Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is
// required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'.
// e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D
// Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
SasToken *string `mandatory:"false" json:"sasToken"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored.
// Note: When provided, 'sasToken' field must not be provided.
SasTokenSecretId *string `mandatory:"false" json:"sasTokenSecretId"`
// Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
AzureTenantId *string `mandatory:"false" json:"azureTenantId"`
// Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"false" json:"clientId"`
// Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'.
// e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1
// Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Azure Storage service endpoint.
// e.g: https://test.blob.core.windows.net
Endpoint *string `mandatory:"false" json:"endpoint"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Used authentication mechanism to access Azure Data Lake Storage.
AuthenticationType AzureDataLakeStorageConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m UpdateAzureDataLakeStorageConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateAzureDataLakeStorageConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateAzureDataLakeStorageConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateAzureDataLakeStorageConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateAzureDataLakeStorageConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateAzureDataLakeStorageConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateAzureDataLakeStorageConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateAzureDataLakeStorageConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateAzureDataLakeStorageConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateAzureDataLakeStorageConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateAzureDataLakeStorageConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAzureDataLakeStorageConnectionDetails) String() string
func (m UpdateAzureDataLakeStorageConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAzureSynapseConnectionDetails The information to update a Azure Synapse Analytics Connection.
type UpdateAzureSynapseConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// JDBC connection string.
// e.g.: 'jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db-name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateAzureSynapseConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateAzureSynapseConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateAzureSynapseConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateAzureSynapseConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateAzureSynapseConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateAzureSynapseConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateAzureSynapseConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateAzureSynapseConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateAzureSynapseConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateAzureSynapseConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateAzureSynapseConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAzureSynapseConnectionDetails) String() string
func (m UpdateAzureSynapseConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackupScheduleDetails Defines the backup schedule details for update operation.
type UpdateBackupScheduleDetails struct {
// The start timestamp for the deployment backup schedule. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.
TimeBackupScheduled *common.SDKTime `mandatory:"false" json:"timeBackupScheduled"`
// The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
FrequencyBackupScheduled UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum `mandatory:"false" json:"frequencyBackupScheduled,omitempty"`
// Name of the bucket where the object is to be uploaded in the object storage
BucketName *string `mandatory:"false" json:"bucketName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Name of namespace that serves as a container for all of your buckets
NamespaceName *string `mandatory:"false" json:"namespaceName"`
// Parameter to allow users to create backup without trails
IsMetadataOnly *bool `mandatory:"false" json:"isMetadataOnly"`
}
func (m UpdateBackupScheduleDetails) String() string
func (m UpdateBackupScheduleDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum Enum with underlying type: string
type UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum string
Set of constants representing the allowable values for UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum
const (
UpdateBackupScheduleDetailsFrequencyBackupScheduledDaily UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum = "DAILY"
UpdateBackupScheduleDetailsFrequencyBackupScheduledWeekly UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum = "WEEKLY"
UpdateBackupScheduleDetailsFrequencyBackupScheduledMonthly UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum = "MONTHLY"
)
func GetMappingUpdateBackupScheduleDetailsFrequencyBackupScheduledEnum(val string) (UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum, bool)
GetMappingUpdateBackupScheduleDetailsFrequencyBackupScheduledEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateBackupScheduleDetailsFrequencyBackupScheduledEnumValues() []UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum
GetUpdateBackupScheduleDetailsFrequencyBackupScheduledEnumValues Enumerates the set of values for UpdateBackupScheduleDetailsFrequencyBackupScheduledEnum
UpdateConnectionDetails The information to update a Connection.
type UpdateConnectionDetails interface {
// An object's Display Name.
GetDisplayName() *string
// Metadata about this specific object.
GetDescription() *string
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
GetVaultId() *string
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
GetKeyId() *string
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
GetNsgIds() []string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
GetSubnetId() *string
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
GetRoutingMethod() RoutingMethodEnum
// Indicates that sensitive attributes are provided via Secrets.
GetDoesUseSecretIds() *bool
}
UpdateConnectionRequest wrapper for the UpdateConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateConnection.go.html to see an example of how to use UpdateConnectionRequest.
type UpdateConnectionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Connection.
ConnectionId *string `mandatory:"true" contributesTo:"path" name:"connectionId"`
// The new Connection specifications to apply.
UpdateConnectionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateConnectionRequest) String() string
func (request UpdateConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateConnectionResponse wrapper for the UpdateConnection operation
type UpdateConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateConnectionResponse) String() string
UpdateDatabaseRegistrationDetails The information to update a DatabaseRegistration.
type UpdateDatabaseRegistrationDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"false" json:"fqdn"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode UpdateDatabaseRegistrationDetailsSessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// This attribute is expected to be base64 encoded.
// Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
Wallet *string `mandatory:"false" json:"wallet"`
// Credential store alias.
AliasName *string `mandatory:"false" json:"aliasName"`
}
func (m UpdateDatabaseRegistrationDetails) String() string
func (m UpdateDatabaseRegistrationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDatabaseRegistrationDetailsSessionModeEnum Enum with underlying type: string
type UpdateDatabaseRegistrationDetailsSessionModeEnum string
Set of constants representing the allowable values for UpdateDatabaseRegistrationDetailsSessionModeEnum
const (
UpdateDatabaseRegistrationDetailsSessionModeDirect UpdateDatabaseRegistrationDetailsSessionModeEnum = "DIRECT"
UpdateDatabaseRegistrationDetailsSessionModeRedirect UpdateDatabaseRegistrationDetailsSessionModeEnum = "REDIRECT"
)
func GetMappingUpdateDatabaseRegistrationDetailsSessionModeEnum(val string) (UpdateDatabaseRegistrationDetailsSessionModeEnum, bool)
GetMappingUpdateDatabaseRegistrationDetailsSessionModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateDatabaseRegistrationDetailsSessionModeEnumValues() []UpdateDatabaseRegistrationDetailsSessionModeEnum
GetUpdateDatabaseRegistrationDetailsSessionModeEnumValues Enumerates the set of values for UpdateDatabaseRegistrationDetailsSessionModeEnum
UpdateDatabaseRegistrationRequest wrapper for the UpdateDatabaseRegistration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateDatabaseRegistration.go.html to see an example of how to use UpdateDatabaseRegistrationRequest.
type UpdateDatabaseRegistrationRequest struct {
// A unique DatabaseRegistration identifier.
DatabaseRegistrationId *string `mandatory:"true" contributesTo:"path" name:"databaseRegistrationId"`
// The new DatabaseRegistration specifications to apply.
UpdateDatabaseRegistrationDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateDatabaseRegistrationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDatabaseRegistrationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDatabaseRegistrationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDatabaseRegistrationRequest) String() string
func (request UpdateDatabaseRegistrationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDatabaseRegistrationResponse wrapper for the UpdateDatabaseRegistration operation
type UpdateDatabaseRegistrationResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Deprecation date of this API version.
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response UpdateDatabaseRegistrationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDatabaseRegistrationResponse) String() string
UpdateDatabricksConnectionDetails The information to update a Databricks Connection.
type UpdateDatabricksConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Connection URL.
// e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
ConnectionUrl *string `mandatory:"false" json:"connectionUrl"`
// The password used to connect to Databricks.
// Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// OAuth client id, only applicable for authenticationType == OAUTH_M2M
ClientId *string `mandatory:"false" json:"clientId"`
// OAuth client secret, only applicable for authenticationType == OAUTH_M2M
// Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Only applicable for authenticationType == OAUTH_M2M.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
StorageCredentialName *string `mandatory:"false" json:"storageCredentialName"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Used authentication mechanism to access Databricks.
AuthenticationType DatabricksConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m UpdateDatabricksConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateDatabricksConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateDatabricksConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateDatabricksConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateDatabricksConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateDatabricksConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateDatabricksConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateDatabricksConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateDatabricksConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateDatabricksConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateDatabricksConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDatabricksConnectionDetails) String() string
func (m UpdateDatabricksConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDb2ConnectionDetails The information to update a DB2 Connection.
type UpdateDb2ConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The name of the database.
DatabaseName *string `mandatory:"false" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The username Oracle GoldenGate uses to connect to the DB2 database.
// This username must already exist and be available by the DB2 to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated DB2 database.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated DB2 database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The base64 encoded keystore file created at the client containing the server certificate / CA root certificate.
// Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
SslClientKeystoredb *string `mandatory:"false" json:"sslClientKeystoredb"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored,
// which created at the client containing the server certificate / CA root certificate.
// Note: When provided, 'sslClientKeystoredb' field must not be provided.
SslClientKeystoredbSecretId *string `mandatory:"false" json:"sslClientKeystoredbSecretId"`
// The base64 encoded keystash file which contains the encrypted password to the key database file.
// Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
SslClientKeystash *string `mandatory:"false" json:"sslClientKeystash"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored,
// which contains the encrypted password to the key database file.
// Note: When provided, 'sslClientKeystash' field must not be provided.
SslClientKeystashSecretId *string `mandatory:"false" json:"sslClientKeystashSecretId"`
// The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
SslServerCertificate *string `mandatory:"false" json:"sslServerCertificate"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security protocol for the DB2 database.
SecurityProtocol Db2ConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m UpdateDb2ConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateDb2ConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateDb2ConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateDb2ConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateDb2ConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateDb2ConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateDb2ConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateDb2ConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateDb2ConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateDb2ConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateDb2ConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDb2ConnectionDetails) String() string
func (m UpdateDb2ConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDeploymentBackupDetails The information to use to update a Deployment Backup.
type UpdateDeploymentBackupDetails struct {
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDeploymentBackupDetails) String() string
func (m UpdateDeploymentBackupDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDeploymentBackupRequest wrapper for the UpdateDeploymentBackup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateDeploymentBackup.go.html to see an example of how to use UpdateDeploymentBackupRequest.
type UpdateDeploymentBackupRequest struct {
// A unique DeploymentBackup identifier.
DeploymentBackupId *string `mandatory:"true" contributesTo:"path" name:"deploymentBackupId"`
// The information to be updated.
UpdateDeploymentBackupDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateDeploymentBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDeploymentBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDeploymentBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDeploymentBackupRequest) String() string
func (request UpdateDeploymentBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDeploymentBackupResponse wrapper for the UpdateDeploymentBackup operation
type UpdateDeploymentBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeploymentBackup instance
DeploymentBackup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateDeploymentBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDeploymentBackupResponse) String() string
UpdateDeploymentDetails The information to use to update a Deployment.
type UpdateDeploymentDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"false" json:"licenseModel,omitempty"`
// Specifies whether the deployment is used in a production or development/testing environment.
EnvironmentType EnvironmentTypeEnum `mandatory:"false" json:"environmentType,omitempty"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the deployment's private endpoint.
// The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,
// after which the private subnet will be enforced.
SubnetId *string `mandatory:"false" json:"subnetId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy.
// Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy.
// For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
LoadBalancerSubnetId *string `mandatory:"false" json:"loadBalancerSubnetId"`
// True if this object is publicly available.
IsPublic *bool `mandatory:"false" json:"isPublic"`
// A three-label Fully Qualified Domain Name (FQDN) for a resource.
Fqdn *string `mandatory:"false" json:"fqdn"`
// The Minimum number of OCPUs to be made available for this Deployment.
CpuCoreCount *int `mandatory:"false" json:"cpuCoreCount"`
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsAutoScalingEnabled *bool `mandatory:"false" json:"isAutoScalingEnabled"`
OggData *UpdateOggDeploymentDetails `mandatory:"false" json:"oggData"`
MaintenanceWindow *UpdateMaintenanceWindowDetails `mandatory:"false" json:"maintenanceWindow"`
MaintenanceConfiguration *UpdateMaintenanceConfigurationDetails `mandatory:"false" json:"maintenanceConfiguration"`
BackupSchedule *UpdateBackupScheduleDetails `mandatory:"false" json:"backupSchedule"`
}
func (m UpdateDeploymentDetails) String() string
func (m UpdateDeploymentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDeploymentRequest wrapper for the UpdateDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdateDeployment.go.html to see an example of how to use UpdateDeploymentRequest.
type UpdateDeploymentRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// The information to be updated.
UpdateDeploymentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDeploymentRequest) String() string
func (request UpdateDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDeploymentResponse wrapper for the UpdateDeployment operation
type UpdateDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDeploymentResponse) String() string
UpdateElasticsearchConnectionDetails The information to update a Elasticsearch Connection.
type UpdateElasticsearchConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 9200.
// Used for establishing the initial connection to the Elasticsearch cluster.
// Example: `"server1.example.com:4000,server2.example.com:4000"`
Servers *string `mandatory:"false" json:"servers"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Fingerprint required by TLS security protocol.
// Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
Fingerprint *string `mandatory:"false" json:"fingerprint"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security protocol for Elasticsearch.
SecurityProtocol ElasticsearchConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Authentication type for Elasticsearch.
AuthenticationType ElasticsearchConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m UpdateElasticsearchConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateElasticsearchConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateElasticsearchConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateElasticsearchConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateElasticsearchConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateElasticsearchConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateElasticsearchConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateElasticsearchConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateElasticsearchConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateElasticsearchConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateElasticsearchConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateElasticsearchConnectionDetails) String() string
func (m UpdateElasticsearchConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGenericConnectionDetails The information to update a Generic Connection.
type UpdateGenericConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Host and port separated by colon.
// Example: `"server.example.com:1234"`
// For multiple hosts, provide a comma separated list.
// Example: `"server1.example.com:1000,server1.example.com:2000"`
Host *string `mandatory:"false" json:"host"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateGenericConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateGenericConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateGenericConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateGenericConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateGenericConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateGenericConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateGenericConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateGenericConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateGenericConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateGenericConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateGenericConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateGenericConnectionDetails) String() string
func (m UpdateGenericConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGoldenGateConnectionDetails The information to update a GoldenGate Connection.
type UpdateGoldenGateConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
DeploymentId *string `mandatory:"false" json:"deploymentId"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The username credential existing in the Oracle GoldenGate used to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password used to connect to the Oracle GoldenGate accessed trough this connection.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// which is used to connect to the Oracle GoldenGate accessed trough this connection.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateGoldenGateConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateGoldenGateConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateGoldenGateConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateGoldenGateConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateGoldenGateConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateGoldenGateConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateGoldenGateConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateGoldenGateConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateGoldenGateConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateGoldenGateConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateGoldenGateConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateGoldenGateConnectionDetails) String() string
func (m UpdateGoldenGateConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGoogleBigQueryConnectionDetails The information to update a the Google BigQuery Connection.
type UpdateGoogleBigQueryConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The base64 encoded content of the service account key file containing
// the credentials required to use Google BigQuery.
// Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
ServiceAccountKeyFile *string `mandatory:"false" json:"serviceAccountKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google BigQuery.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateGoogleBigQueryConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateGoogleBigQueryConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateGoogleBigQueryConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateGoogleBigQueryConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateGoogleBigQueryConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateGoogleBigQueryConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateGoogleBigQueryConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateGoogleBigQueryConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateGoogleBigQueryConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateGoogleBigQueryConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateGoogleBigQueryConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateGoogleBigQueryConnectionDetails) String() string
func (m UpdateGoogleBigQueryConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGoogleCloudStorageConnectionDetails The information to update a the Google Cloud Storage Connection.
type UpdateGoogleCloudStorageConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The base64 encoded content of the service account key file containing
// the credentials required to use Google Cloud Storage.
// Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
ServiceAccountKeyFile *string `mandatory:"false" json:"serviceAccountKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google Cloud Storage.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateGoogleCloudStorageConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateGoogleCloudStorageConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateGoogleCloudStorageConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateGoogleCloudStorageConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateGoogleCloudStorageConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateGoogleCloudStorageConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateGoogleCloudStorageConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateGoogleCloudStorageConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateGoogleCloudStorageConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateGoogleCloudStorageConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateGoogleCloudStorageConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateGoogleCloudStorageConnectionDetails) String() string
func (m UpdateGoogleCloudStorageConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGooglePubSubConnectionDetails The information to update a the Google PubSub Connection.
type UpdateGooglePubSubConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The base64 encoded content of the service account key file containing
// the credentials required to use Google PubSub.
// Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
ServiceAccountKeyFile *string `mandatory:"false" json:"serviceAccountKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,
// which containing the credentials required to use Google PubSub.
// Note: When provided, 'serviceAccountKeyFile' field must not be provided.
ServiceAccountKeyFileSecretId *string `mandatory:"false" json:"serviceAccountKeyFileSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateGooglePubSubConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateGooglePubSubConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateGooglePubSubConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateGooglePubSubConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateGooglePubSubConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateGooglePubSubConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateGooglePubSubConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateGooglePubSubConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateGooglePubSubConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateGooglePubSubConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateGooglePubSubConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateGooglePubSubConnectionDetails) String() string
func (m UpdateGooglePubSubConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGroupToRolesMappingDetails Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
type UpdateGroupToRolesMappingDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup.
// It grants administration of security related objects and invoke security related service requests. This role has full privileges.
SecurityGroupId *string `mandatory:"false" json:"securityGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup.
// It grants full access to the user, including the ability to alter general, non-security related operational parameters
// and profiles of the server.
AdministratorGroupId *string `mandatory:"false" json:"administratorGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup.
// It allows users to perform only operational actions, like starting and stopping resources.
// Operators cannot alter the operational parameters or profiles of the MA server.
OperatorGroupId *string `mandatory:"false" json:"operatorGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup.
// It allows information-only service requests, which do not alter or affect the operation of either the MA.
// Examples of query and read-only information include performance metric information and resource status and monitoring information
UserGroupId *string `mandatory:"false" json:"userGroupId"`
}
func (m UpdateGroupToRolesMappingDetails) String() string
func (m UpdateGroupToRolesMappingDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateHdfsConnectionDetails The information to update a Hadoop Distributed File System Connection.
type UpdateHdfsConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
CoreSiteXml *string `mandatory:"false" json:"coreSiteXml"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateHdfsConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateHdfsConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateHdfsConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateHdfsConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateHdfsConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateHdfsConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateHdfsConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateHdfsConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateHdfsConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateHdfsConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateHdfsConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateHdfsConnectionDetails) String() string
func (m UpdateHdfsConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateJavaMessageServiceConnectionDetails The information to update a Java Message Service Connection.
type UpdateJavaMessageServiceConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
ShouldUseJndi *bool `mandatory:"false" json:"shouldUseJndi"`
// The Connection Factory can be looked up using this name.
// e.g.: 'ConnectionFactory'
JndiConnectionFactory *string `mandatory:"false" json:"jndiConnectionFactory"`
// The URL that Java Message Service will use to contact the JNDI provider.
// e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
JndiProviderUrl *string `mandatory:"false" json:"jndiProviderUrl"`
// The implementation of javax.naming.spi.InitialContextFactory interface
// that the client uses to obtain initial naming context.
// e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
JndiInitialContextFactory *string `mandatory:"false" json:"jndiInitialContextFactory"`
// Specifies the identity of the principal (user) to be authenticated.
// e.g.: 'admin2'
JndiSecurityPrincipal *string `mandatory:"false" json:"jndiSecurityPrincipal"`
// The password associated to the principal.
// Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
JndiSecurityCredentials *string `mandatory:"false" json:"jndiSecurityCredentials"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal.
// Note: When provided, 'jndiSecurityCredentials' field must not be provided.
JndiSecurityCredentialsSecretId *string `mandatory:"false" json:"jndiSecurityCredentialsSecretId"`
// Connectin URL of the Java Message Service, specifying the protocol, host, and port.
// e.g.: 'mq://myjms.host.domain:7676'
ConnectionUrl *string `mandatory:"false" json:"connectionUrl"`
// The of Java class implementing javax.jms.ConnectionFactory interface
// supplied by the Java Message Service provider.
// e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
ConnectionFactory *string `mandatory:"false" json:"connectionFactory"`
// The username Oracle GoldenGate uses to connect to the Java Message Service.
// This username must already exist and be available by the Java Message Service to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated Java Message Service.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,
// that Oracle GoldenGate uses to connect the associated Java Message Service.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The password for the cert inside of the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
SslKeyPassword *string `mandatory:"false" json:"sslKeyPassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored for the cert inside of the Keystore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security protocol for Java Message Service. If not provided, default is PLAIN.
// Optional until 2024-06-27, in the release after it will be made required.
SecurityProtocol JavaMessageServiceConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Authentication type for Java Message Service. If not provided, default is NONE.
// Optional until 2024-06-27, in the release after it will be made required.
AuthenticationType JavaMessageServiceConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m UpdateJavaMessageServiceConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateJavaMessageServiceConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateJavaMessageServiceConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateJavaMessageServiceConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateJavaMessageServiceConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateJavaMessageServiceConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateJavaMessageServiceConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateJavaMessageServiceConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateJavaMessageServiceConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateJavaMessageServiceConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateJavaMessageServiceConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateJavaMessageServiceConnectionDetails) String() string
func (m UpdateJavaMessageServiceConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateKafkaConnectionDetails The information to update a Kafka Connection.
type UpdateKafkaConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced.
StreamPoolId *string `mandatory:"false" json:"streamPoolId"`
// Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka:
// list of KafkaBootstrapServer objects specified by host/port.
// Used for establishing the initial connection to the Kafka cluster.
// Example: `"server1.example.com:9092,server2.example.com:9092"`
BootstrapServers []KafkaBootstrapServer `mandatory:"false" json:"bootstrapServers"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The password for the cert inside of the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
SslKeyPassword *string `mandatory:"false" json:"sslKeyPassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// The base64 encoded content of the consumer.properties file.
ConsumerProperties *string `mandatory:"false" json:"consumerProperties"`
// The base64 encoded content of the producer.properties file.
ProducerProperties *string `mandatory:"false" json:"producerProperties"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security Type for Kafka.
SecurityProtocol KafkaConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m UpdateKafkaConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateKafkaConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateKafkaConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateKafkaConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateKafkaConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateKafkaConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateKafkaConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateKafkaConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateKafkaConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateKafkaConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateKafkaConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateKafkaConnectionDetails) String() string
func (m UpdateKafkaConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateKafkaSchemaRegistryConnectionDetails The information to update Kafka (e.g. Confluent) Schema Registry Connection.
type UpdateKafkaSchemaRegistryConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Kafka Schema Registry URL.
// e.g.: 'https://server1.us.oracle.com:8081'
Url *string `mandatory:"false" json:"url"`
// The username to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
Username *string `mandatory:"false" json:"username"`
// The password to access Schema Registry using basic authentication.
// This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The password for the cert inside the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
SslKeyPassword *string `mandatory:"false" json:"sslKeyPassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the cert inside the KeyStore.
// In case it differs from the KeyStore password, it should be provided.
// Note: When provided, 'sslKeyPassword' field must not be provided.
SslKeyPasswordSecretId *string `mandatory:"false" json:"sslKeyPasswordSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Used authentication mechanism to access Schema Registry.
AuthenticationType KafkaSchemaRegistryConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateKafkaSchemaRegistryConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateKafkaSchemaRegistryConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateKafkaSchemaRegistryConnectionDetails) String() string
func (m UpdateKafkaSchemaRegistryConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMaintenanceConfigurationDetails Defines the maintenance configuration for update operation.
type UpdateMaintenanceConfigurationDetails struct {
// By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release,
// you have to specify interimReleaseUpgradePeriodInDays too.
IsInterimReleaseAutoUpgradeEnabled *bool `mandatory:"false" json:"isInterimReleaseAutoUpgradeEnabled"`
// Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
InterimReleaseUpgradePeriodInDays *int `mandatory:"false" json:"interimReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases.
// This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
BundleReleaseUpgradePeriodInDays *int `mandatory:"false" json:"bundleReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases.
// Not passing this field during create will equate to using the service default.
MajorReleaseUpgradePeriodInDays *int `mandatory:"false" json:"majorReleaseUpgradePeriodInDays"`
// Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases.
// Not passing this field during create will equate to using the service default.
SecurityPatchUpgradePeriodInDays *int `mandatory:"false" json:"securityPatchUpgradePeriodInDays"`
}
func (m UpdateMaintenanceConfigurationDetails) String() string
func (m UpdateMaintenanceConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMaintenanceWindowDetails Defines the maintenance window for update operation, when automatic actions can be performed.
type UpdateMaintenanceWindowDetails struct {
// Days of the week.
Day DayEnum `mandatory:"true" json:"day"`
// Start hour for maintenance period. Hour is in UTC.
StartHour *int `mandatory:"true" json:"startHour"`
}
func (m UpdateMaintenanceWindowDetails) String() string
func (m UpdateMaintenanceWindowDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMicrosoftFabricConnectionDetails The information to update a Microsoft Fabric Connection.
type UpdateMicrosoftFabricConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Azure tenant ID of the application.
// e.g.: 14593954-d337-4a61-a364-9f758c64f97f
TenantId *string `mandatory:"false" json:"tenantId"`
// Azure client ID of the application.
// e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientId *string `mandatory:"false" json:"clientId"`
// Client secret associated with the client id.
// Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.
// Note: When provided, 'clientSecret' field must not be provided.
ClientSecretSecretId *string `mandatory:"false" json:"clientSecretSecretId"`
// Optional Microsoft Fabric service endpoint.
// Default value: https://onelake.dfs.fabric.microsoft.com
Endpoint *string `mandatory:"false" json:"endpoint"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateMicrosoftFabricConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateMicrosoftFabricConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateMicrosoftFabricConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateMicrosoftFabricConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateMicrosoftFabricConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateMicrosoftFabricConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateMicrosoftFabricConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateMicrosoftFabricConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateMicrosoftFabricConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateMicrosoftFabricConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateMicrosoftFabricConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMicrosoftFabricConnectionDetails) String() string
func (m UpdateMicrosoftFabricConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMicrosoftSqlserverConnectionDetails The information to update a Microsoft SQL Server Connection.
type UpdateMicrosoftSqlserverConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The name of the database.
DatabaseName *string `mandatory:"false" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The username Oracle GoldenGate uses to connect to the Microsoft SQL Server.
// This username must already exist and be available by the Microsoft SQL Server to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// Database Certificate - The base64 encoded content of a .pem or .crt file.
// containing the server public key (for 1-way SSL).
SslCa *string `mandatory:"false" json:"sslCa"`
// If set to true, the driver validates the certificate that is sent by the database server.
ShouldValidateServerCertificate *bool `mandatory:"false" json:"shouldValidateServerCertificate"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security Type for Microsoft SQL Server.
SecurityProtocol MicrosoftSqlserverConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m UpdateMicrosoftSqlserverConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateMicrosoftSqlserverConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateMicrosoftSqlserverConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateMicrosoftSqlserverConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateMicrosoftSqlserverConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateMicrosoftSqlserverConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateMicrosoftSqlserverConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateMicrosoftSqlserverConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateMicrosoftSqlserverConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateMicrosoftSqlserverConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateMicrosoftSqlserverConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMicrosoftSqlserverConnectionDetails) String() string
func (m UpdateMicrosoftSqlserverConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMongoDbConnectionDetails The information to update a MongoDB Connection.
type UpdateMongoDbConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// MongoDB connection string.
// e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The username Oracle GoldenGate uses to connect to the database.
// This username must already exist and be available by the database to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated database.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated database.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
TlsCaFile *string `mandatory:"false" json:"tlsCaFile"`
// Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL).
// Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
TlsCertificateKeyFile *string `mandatory:"false" json:"tlsCertificateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection.
// - The content of a .pem file containing the client private key (for 2-way SSL).
// Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
TlsCertificateKeyFileSecretId *string `mandatory:"false" json:"tlsCertificateKeyFileSecretId"`
// Client Certificate key file password.
// Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
TlsCertificateKeyFilePassword *string `mandatory:"false" json:"tlsCertificateKeyFilePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file.
// Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
TlsCertificateKeyFilePasswordSecretId *string `mandatory:"false" json:"tlsCertificateKeyFilePasswordSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security Type for MongoDB.
SecurityProtocol MongoDbConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
}
func (m UpdateMongoDbConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateMongoDbConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateMongoDbConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateMongoDbConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateMongoDbConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateMongoDbConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateMongoDbConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateMongoDbConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateMongoDbConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateMongoDbConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateMongoDbConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMongoDbConnectionDetails) String() string
func (m UpdateMongoDbConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMysqlConnectionDetails The information to update a MySQL Connection.
type UpdateMysqlConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The name of the database.
DatabaseName *string `mandatory:"false" json:"databaseName"`
// Database Certificate - The base64 encoded content of a .pem or .crt file.
// containing the server public key (for 1 and 2-way SSL).
SslCa *string `mandatory:"false" json:"sslCa"`
// The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
// Note: This is an optional property and only applicable if TLS/MTLS option is selected.
SslCrl *string `mandatory:"false" json:"sslCrl"`
// Client Certificate - The base64 encoded content of a .pem or .crt file.
// containing the client public key (for 2-way SSL).
SslCert *string `mandatory:"false" json:"sslCert"`
// Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).
// Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
SslKey *string `mandatory:"false" json:"sslKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the Client Key
// - The content of a .pem or .crt file containing the client private key (for 2-way SSL).
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security Type for MySQL.
SecurityProtocol MysqlConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// SSL modes for MySQL.
SslMode MysqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
}
func (m UpdateMysqlConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateMysqlConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateMysqlConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateMysqlConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateMysqlConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateMysqlConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateMysqlConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateMysqlConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateMysqlConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateMysqlConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateMysqlConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMysqlConnectionDetails) String() string
func (m UpdateMysqlConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateOciObjectStorageConnectionDetails The information to update a OCI Object Storage Connection.
type UpdateOciObjectStorageConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Object Storage.
// The user must have write access to the bucket they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"false" json:"userId"`
// The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
PrivateKeyFile *string `mandatory:"false" json:"privateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The passphrase of the private key.
// Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
PrivateKeyPassphrase *string `mandatory:"false" json:"privateKeyPassphrase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// The fingerprint of the API Key of the user specified by the userId.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
PublicKeyFingerprint *string `mandatory:"false" json:"publicKeyFingerprint"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateOciObjectStorageConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateOciObjectStorageConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateOciObjectStorageConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateOciObjectStorageConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateOciObjectStorageConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateOciObjectStorageConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateOciObjectStorageConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateOciObjectStorageConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateOciObjectStorageConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateOciObjectStorageConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateOciObjectStorageConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateOciObjectStorageConnectionDetails) String() string
func (m UpdateOciObjectStorageConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateOggDeploymentDetails Deployment Details for updating an OggDeployment
type UpdateOggDeploymentDetails struct {
// The type of credential store for OGG.
CredentialStore CredentialStoreEnum `mandatory:"false" json:"credentialStore,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.
IdentityDomainId *string `mandatory:"false" json:"identityDomainId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The GoldenGate deployment console username.
AdminUsername *string `mandatory:"false" json:"adminUsername"`
// The password associated with the GoldenGate deployment console username.
// The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric,
// and 1 special character. Special characters such as '$', '^', or '?' are not allowed.
// This field will be deprecated and replaced by "passwordSecretId".
AdminPassword *string `mandatory:"false" json:"adminPassword"`
// The base64 encoded content of the PEM file containing the SSL certificate.
Certificate *string `mandatory:"false" json:"certificate"`
// The base64 encoded content of the PEM file containing the private key.
Key *string `mandatory:"false" json:"key"`
GroupToRolesMapping *UpdateGroupToRolesMappingDetails `mandatory:"false" json:"groupToRolesMapping"`
}
func (m UpdateOggDeploymentDetails) String() string
func (m UpdateOggDeploymentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateOracleConnectionDetails The information to update an Oracle Database Connection.
type UpdateOracleConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// Connect descriptor or Easy Connect Naming method used to connect to a database.
ConnectionString *string `mandatory:"false" json:"connectionString"`
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// This attribute is expected to be base64 encoded.
// Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
Wallet *string `mandatory:"false" json:"wallet"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored.
// The wallet contents Oracle GoldenGate uses to make connections to a database.
// Note: When provided, 'wallet' field must not be provided.
WalletSecretId *string `mandatory:"false" json:"walletSecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections,
// when a databaseId is provided. The default value is MTLS.
AuthenticationMode OracleConnectionAuthenticationModeEnum `mandatory:"false" json:"authenticationMode,omitempty"`
// The mode of the database connection session to be established by the data client.
// 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database.
// Connection to a RAC database involves a redirection received from the SCAN listeners
// to the database node to connect to. By default the mode would be DIRECT.
SessionMode OracleConnectionSessionModeEnum `mandatory:"false" json:"sessionMode,omitempty"`
}
func (m UpdateOracleConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateOracleConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateOracleConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateOracleConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateOracleConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateOracleConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateOracleConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateOracleConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateOracleConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateOracleConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateOracleConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateOracleConnectionDetails) String() string
func (m UpdateOracleConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateOracleNosqlConnectionDetails The information to update a Oracle NoSQL Connection.
type UpdateOracleNosqlConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The name of the region. e.g.: us-ashburn-1
// If the region is not provided, backend will default to the default region.
Region *string `mandatory:"false" json:"region"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Oracle NoSQL database.
// The user must have write access to the table they want to connect to.
// If the user is not provided, backend will default to the user who is calling the API endpoint.
UserId *string `mandatory:"false" json:"userId"`
// The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
PrivateKeyFile *string `mandatory:"false" json:"privateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// The passphrase of the private key.
// Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
PrivateKeyPassphrase *string `mandatory:"false" json:"privateKeyPassphrase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// The fingerprint of the API Key of the user specified by the userId.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
PublicKeyFingerprint *string `mandatory:"false" json:"publicKeyFingerprint"`
// Indicates that the user intents to connect to the instance through resource principal.
ShouldUseResourcePrincipal *bool `mandatory:"false" json:"shouldUseResourcePrincipal"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
}
func (m UpdateOracleNosqlConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateOracleNosqlConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateOracleNosqlConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateOracleNosqlConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateOracleNosqlConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateOracleNosqlConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateOracleNosqlConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateOracleNosqlConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateOracleNosqlConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateOracleNosqlConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateOracleNosqlConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateOracleNosqlConnectionDetails) String() string
func (m UpdateOracleNosqlConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePipelineDetails Information with which to update a pipeline.
type UpdatePipelineDetails interface {
// An object's Display Name.
GetDisplayName() *string
// Metadata about this specific object.
GetDescription() *string
// The Oracle license model that applies to a Deployment.
GetLicenseModel() LicenseModelEnum
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
UpdatePipelineRequest wrapper for the UpdatePipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpdatePipeline.go.html to see an example of how to use UpdatePipelineRequest.
type UpdatePipelineRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline created.
PipelineId *string `mandatory:"true" contributesTo:"path" name:"pipelineId"`
// The existing pipeline specifications to apply.
UpdatePipelineDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdatePipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePipelineRequest) String() string
func (request UpdatePipelineRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePipelineResponse wrapper for the UpdatePipeline operation
type UpdatePipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdatePipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePipelineResponse) String() string
UpdatePostgresqlConnectionDetails The information to update a PostgreSQL Database Connection.
type UpdatePostgresqlConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// The name of the database.
DatabaseName *string `mandatory:"false" json:"databaseName"`
// The name or address of a host.
Host *string `mandatory:"false" json:"host"`
// The port of an endpoint usually specified for a connection.
Port *int `mandatory:"false" json:"port"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// An array of name-value pair attribute entries.
// Used as additional parameters in connection string.
AdditionalAttributes []NameValuePair `mandatory:"false" json:"additionalAttributes"`
// The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.
// The supported file formats are .pem and .crt.
SslCa *string `mandatory:"false" json:"sslCa"`
// The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
SslCrl *string `mandatory:"false" json:"sslCrl"`
// The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt.
SslCert *string `mandatory:"false" json:"sslCert"`
// The base64 encoded private key of the PostgreSQL server. The supported file formats are .pem and .crt.
// Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
SslKey *string `mandatory:"false" json:"sslKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt.
// Note: When provided, 'sslKey' field must not be provided.
SslKeySecretId *string `mandatory:"false" json:"sslKeySecretId"`
// Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host
// field, or make sure the host name is resolvable in the target VCN.
// The private IP address of the connection's endpoint in the customer's VCN, typically a
// database endpoint or a big data endpoint (e.g. Kafka bootstrap server).
// In case the privateIp is provided, the subnetId must also be provided.
// In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible.
// In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security protocol for PostgreSQL.
SecurityProtocol PostgresqlConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// SSL modes for PostgreSQL.
SslMode PostgresqlConnectionSslModeEnum `mandatory:"false" json:"sslMode,omitempty"`
}
func (m UpdatePostgresqlConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdatePostgresqlConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdatePostgresqlConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdatePostgresqlConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdatePostgresqlConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdatePostgresqlConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdatePostgresqlConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdatePostgresqlConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdatePostgresqlConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdatePostgresqlConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdatePostgresqlConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdatePostgresqlConnectionDetails) String() string
func (m UpdatePostgresqlConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRedisConnectionDetails The information to update a Redis Database Connection.
type UpdateRedisConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional.
// If port is not specified, it defaults to 6379.
// Used for establishing the initial connection to the Redis cluster.
// Example: `"server1.example.com:6379,server2.example.com:6379"`
Servers *string `mandatory:"false" json:"servers"`
// The username Oracle GoldenGate uses to connect the associated system of the given technology.
// This username must already exist and be available by the system/application to be connected to
// and must conform to the case sensitivty requirments defined in it.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.
// The password Oracle GoldenGate uses to connect the associated system of the given technology.
// It must conform to the specific security requirements including length, case sensitivity, and so on.
// If secretId is used plaintext field must not be provided.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of the TrustStore file.
// Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
TrustStore *string `mandatory:"false" json:"trustStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.
// Note: When provided, 'trustStore' field must not be provided.
TrustStoreSecretId *string `mandatory:"false" json:"trustStoreSecretId"`
// The TrustStore password.
// Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
TrustStorePassword *string `mandatory:"false" json:"trustStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis TrustStore password is stored.
// Note: When provided, 'trustStorePassword' field must not be provided.
TrustStorePasswordSecretId *string `mandatory:"false" json:"trustStorePasswordSecretId"`
// The base64 encoded content of the KeyStore file.
// Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
KeyStore *string `mandatory:"false" json:"keyStore"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.
// Note: When provided, 'keyStore' field must not be provided.
KeyStoreSecretId *string `mandatory:"false" json:"keyStoreSecretId"`
// The KeyStore password.
// Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
KeyStorePassword *string `mandatory:"false" json:"keyStorePassword"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis KeyStore password is stored.
// Note: When provided, 'keyStorePassword' field must not be provided.
KeyStorePasswordSecretId *string `mandatory:"false" json:"keyStorePasswordSecretId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Redis cluster.
RedisClusterId *string `mandatory:"false" json:"redisClusterId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Security protocol for Redis.
SecurityProtocol RedisConnectionSecurityProtocolEnum `mandatory:"false" json:"securityProtocol,omitempty"`
// Authenticationentication type for the Redis database.
AuthenticationType RedisConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m UpdateRedisConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateRedisConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateRedisConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateRedisConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateRedisConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateRedisConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateRedisConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateRedisConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateRedisConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateRedisConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateRedisConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateRedisConnectionDetails) String() string
func (m UpdateRedisConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSnowflakeConnectionDetails The information to update a Snowflake Connection.
type UpdateSnowflakeConnectionDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Refers to the customer's vault OCID.
// If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate
// to manage secrets contained within this vault.
VaultId *string `mandatory:"false" json:"vaultId"`
// Refers to the customer's master key OCID.
// If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
KeyId *string `mandatory:"false" json:"keyId"`
// An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Indicates that sensitive attributes are provided via Secrets.
DoesUseSecretIds *bool `mandatory:"false" json:"doesUseSecretIds"`
// JDBC connection URL.
// e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>'
ConnectionUrl *string `mandatory:"false" json:"connectionUrl"`
// The username Oracle GoldenGate uses to connect to Snowflake.
// This username must already exist and be available by Snowflake platform to be connected to.
Username *string `mandatory:"false" json:"username"`
// The password Oracle GoldenGate uses to connect to Snowflake platform.
// Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
Password *string `mandatory:"false" json:"password"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect to Snowflake platform.
// Note: When provided, 'password' field must not be provided.
PasswordSecretId *string `mandatory:"false" json:"passwordSecretId"`
// The base64 encoded content of private key file in PEM format.
// Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
PrivateKeyFile *string `mandatory:"false" json:"privateKeyFile"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
// See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
// Note: When provided, 'privateKeyFile' field must not be provided.
PrivateKeyFileSecretId *string `mandatory:"false" json:"privateKeyFileSecretId"`
// Password if the private key file is encrypted.
// Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
PrivateKeyPassphrase *string `mandatory:"false" json:"privateKeyPassphrase"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the private key file.
// Note: When provided, 'privateKeyPassphrase' field must not be provided.
PrivateKeyPassphraseSecretId *string `mandatory:"false" json:"privateKeyPassphraseSecretId"`
// Controls the network traffic direction to the target:
// SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
// SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.
// DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
RoutingMethod RoutingMethodEnum `mandatory:"false" json:"routingMethod,omitempty"`
// Used authentication mechanism to access Snowflake.
AuthenticationType SnowflakeConnectionAuthenticationTypeEnum `mandatory:"false" json:"authenticationType,omitempty"`
}
func (m UpdateSnowflakeConnectionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateSnowflakeConnectionDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateSnowflakeConnectionDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateSnowflakeConnectionDetails) GetDoesUseSecretIds() *bool
GetDoesUseSecretIds returns DoesUseSecretIds
func (m UpdateSnowflakeConnectionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateSnowflakeConnectionDetails) GetKeyId() *string
GetKeyId returns KeyId
func (m UpdateSnowflakeConnectionDetails) GetNsgIds() []string
GetNsgIds returns NsgIds
func (m UpdateSnowflakeConnectionDetails) GetRoutingMethod() RoutingMethodEnum
GetRoutingMethod returns RoutingMethod
func (m UpdateSnowflakeConnectionDetails) GetSubnetId() *string
GetSubnetId returns SubnetId
func (m UpdateSnowflakeConnectionDetails) GetVaultId() *string
GetVaultId returns VaultId
func (m UpdateSnowflakeConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateSnowflakeConnectionDetails) String() string
func (m UpdateSnowflakeConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateZeroEtlPipelineDetails Information to update for an existing ZeroETL pipeline.
type UpdateZeroEtlPipelineDetails struct {
// An object's Display Name.
DisplayName *string `mandatory:"false" json:"displayName"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
ProcessOptions *ProcessOptions `mandatory:"false" json:"processOptions"`
// Mapping for source/target schema/tables for the pipeline data replication.
MappingRules []MappingRule `mandatory:"false" json:"mappingRules"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"false" json:"licenseModel,omitempty"`
}
func (m UpdateZeroEtlPipelineDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateZeroEtlPipelineDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateZeroEtlPipelineDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateZeroEtlPipelineDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateZeroEtlPipelineDetails) GetLicenseModel() LicenseModelEnum
GetLicenseModel returns LicenseModel
func (m UpdateZeroEtlPipelineDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateZeroEtlPipelineDetails) String() string
func (m UpdateZeroEtlPipelineDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpgradeDeploymentCurrentReleaseDetails Definition of the additional attributes for a Current Release upgrade.
type UpgradeDeploymentCurrentReleaseDetails struct {
}
func (m UpgradeDeploymentCurrentReleaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpgradeDeploymentCurrentReleaseDetails) String() string
func (m UpgradeDeploymentCurrentReleaseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpgradeDeploymentDetails The information about the Upgrade for a Deployment.
type UpgradeDeploymentDetails interface {
}
UpgradeDeploymentRequest wrapper for the UpgradeDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpgradeDeployment.go.html to see an example of how to use UpgradeDeploymentRequest.
type UpgradeDeploymentRequest struct {
// A unique Deployment identifier.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// A placeholder for any additional metadata to describe the deployment upgrade.
UpgradeDeploymentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpgradeDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpgradeDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpgradeDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpgradeDeploymentRequest) String() string
func (request UpgradeDeploymentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpgradeDeploymentResponse wrapper for the UpgradeDeployment operation
type UpgradeDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpgradeDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpgradeDeploymentResponse) String() string
UpgradeDeploymentSpecificReleaseDetails Definition of the additional attributes for a Specific Release upgrade.
type UpgradeDeploymentSpecificReleaseDetails struct {
// Version of OGG
OggVersion *string `mandatory:"true" json:"oggVersion"`
}
func (m UpgradeDeploymentSpecificReleaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpgradeDeploymentSpecificReleaseDetails) String() string
func (m UpgradeDeploymentSpecificReleaseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpgradeDeploymentTypeEnum Enum with underlying type: string
type UpgradeDeploymentTypeEnum string
Set of constants representing the allowable values for UpgradeDeploymentTypeEnum
const (
UpgradeDeploymentTypeCurrentRelease UpgradeDeploymentTypeEnum = "CURRENT_RELEASE"
UpgradeDeploymentTypeSpecificRelease UpgradeDeploymentTypeEnum = "SPECIFIC_RELEASE"
)
func GetMappingUpgradeDeploymentTypeEnum(val string) (UpgradeDeploymentTypeEnum, bool)
GetMappingUpgradeDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpgradeDeploymentTypeEnumValues() []UpgradeDeploymentTypeEnum
GetUpgradeDeploymentTypeEnumValues Enumerates the set of values for UpgradeDeploymentTypeEnum
UpgradeDeploymentUpgradeDetails The information about the upgrade for a deployment.
type UpgradeDeploymentUpgradeDetails interface {
}
UpgradeDeploymentUpgradeRequest wrapper for the UpgradeDeploymentUpgrade operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/goldengate/UpgradeDeploymentUpgrade.go.html to see an example of how to use UpgradeDeploymentUpgradeRequest.
type UpgradeDeploymentUpgradeRequest struct {
// A unique Deployment Upgrade identifier.
DeploymentUpgradeId *string `mandatory:"true" contributesTo:"path" name:"deploymentUpgradeId"`
// A placeholder for any additional metadata to describe the deployment upgrade.
UpgradeDeploymentUpgradeDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for that
// resource. The resource is updated or deleted only if the etag you provide matches the
// resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried, in case of a timeout or server error,
// without the risk of executing that same action again. Retry tokens expire after 24 hours but can be
// invalidated before then due to conflicting operations. For example, if a resource was deleted and purged
// from the system, then a retry of the original creation request is rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Whether to override locks (if any exist).
IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpgradeDeploymentUpgradeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpgradeDeploymentUpgradeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpgradeDeploymentUpgradeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpgradeDeploymentUpgradeRequest) String() string
func (request UpgradeDeploymentUpgradeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpgradeDeploymentUpgradeResponse wrapper for the UpgradeDeploymentUpgrade operation
type UpgradeDeploymentUpgradeResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for an asynchronous request. You can use this to query
// status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please include the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpgradeDeploymentUpgradeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpgradeDeploymentUpgradeResponse) String() string
UpgradeDeploymentUpgradeTypeEnum Enum with underlying type: string
type UpgradeDeploymentUpgradeTypeEnum string
Set of constants representing the allowable values for UpgradeDeploymentUpgradeTypeEnum
const (
UpgradeDeploymentUpgradeTypeDefault UpgradeDeploymentUpgradeTypeEnum = "DEFAULT"
)
func GetMappingUpgradeDeploymentUpgradeTypeEnum(val string) (UpgradeDeploymentUpgradeTypeEnum, bool)
GetMappingUpgradeDeploymentUpgradeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpgradeDeploymentUpgradeTypeEnumValues() []UpgradeDeploymentUpgradeTypeEnum
GetUpgradeDeploymentUpgradeTypeEnumValues Enumerates the set of values for UpgradeDeploymentUpgradeTypeEnum
WalletExistsDeploymentTypeEnum Enum with underlying type: string
type WalletExistsDeploymentTypeEnum string
Set of constants representing the allowable values for WalletExistsDeploymentTypeEnum
const (
WalletExistsDeploymentTypeDefault WalletExistsDeploymentTypeEnum = "DEFAULT"
)
func GetMappingWalletExistsDeploymentTypeEnum(val string) (WalletExistsDeploymentTypeEnum, bool)
GetMappingWalletExistsDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWalletExistsDeploymentTypeEnumValues() []WalletExistsDeploymentTypeEnum
GetWalletExistsDeploymentTypeEnumValues Enumerates the set of values for WalletExistsDeploymentTypeEnum
WorkRequest The API operations that create and configure GoldenGate resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running asynchronous workflows.
type WorkRequest struct {
// The work request's operation type.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped
// to the same compartment as the resource the work request affects. If the work request
// affects multiple resources, and those resources are not in the same compartment, it is up
// to the service team to pick the primary resource whose compartment should be used.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request. When
// you create, update, or delete a resource, it remains in the IN_PROGRESS state until work
// is complete for that resource. It then transitions to CREATED, UPDATED, or DELETED,
// respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you perform a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ZeroEtlPipeline The details of a ZeroETL pipeline.
type ZeroEtlPipeline struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The Minimum number of OCPUs to be made available for this Deployment.
CpuCoreCount *int `mandatory:"true" json:"cpuCoreCount"`
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
SourceConnectionDetails *SourcePipelineConnectionDetails `mandatory:"true" json:"sourceConnectionDetails"`
TargetConnectionDetails *TargetPipelineConnectionDetails `mandatory:"true" json:"targetConnectionDetails"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Mapping for source/target schema/tables for the pipeline data replication.
MappingRules []MappingRule `mandatory:"false" json:"mappingRules"`
ProcessOptions *ProcessOptions `mandatory:"false" json:"processOptions"`
// When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.
TimeLastRecorded *common.SDKTime `mandatory:"false" json:"timeLastRecorded"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"true" json:"licenseModel"`
// Lifecycle state of the pipeline.
LifecycleState PipelineLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Possible lifecycle substates when retrieving a pipeline.
LifecycleSubState PipelineLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
}
func (m ZeroEtlPipeline) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ZeroEtlPipeline) GetCpuCoreCount() *int
GetCpuCoreCount returns CpuCoreCount
func (m ZeroEtlPipeline) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ZeroEtlPipeline) GetDescription() *string
GetDescription returns Description
func (m ZeroEtlPipeline) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m ZeroEtlPipeline) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ZeroEtlPipeline) GetId() *string
GetId returns Id
func (m ZeroEtlPipeline) GetIsAutoScalingEnabled() *bool
GetIsAutoScalingEnabled returns IsAutoScalingEnabled
func (m ZeroEtlPipeline) GetLicenseModel() LicenseModelEnum
GetLicenseModel returns LicenseModel
func (m ZeroEtlPipeline) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m ZeroEtlPipeline) GetLifecycleState() PipelineLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ZeroEtlPipeline) GetLifecycleSubState() PipelineLifecycleSubStateEnum
GetLifecycleSubState returns LifecycleSubState
func (m ZeroEtlPipeline) GetLocks() []ResourceLock
GetLocks returns Locks
func (m ZeroEtlPipeline) GetSourceConnectionDetails() *SourcePipelineConnectionDetails
GetSourceConnectionDetails returns SourceConnectionDetails
func (m ZeroEtlPipeline) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m ZeroEtlPipeline) GetTargetConnectionDetails() *TargetPipelineConnectionDetails
GetTargetConnectionDetails returns TargetConnectionDetails
func (m ZeroEtlPipeline) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ZeroEtlPipeline) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ZeroEtlPipeline) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ZeroEtlPipeline) String() string
func (m ZeroEtlPipeline) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ZeroEtlPipelineSummary Summary of the ZeroETL pipeline.
type ZeroEtlPipelineSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.
Id *string `mandatory:"true" json:"id"`
// An object's Display Name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
SourceConnectionDetails *SourcePipelineConnectionDetails `mandatory:"true" json:"sourceConnectionDetails"`
TargetConnectionDetails *TargetPipelineConnectionDetails `mandatory:"true" json:"targetConnectionDetails"`
// The Minimum number of OCPUs to be made available for this Deployment.
CpuCoreCount *int `mandatory:"true" json:"cpuCoreCount"`
// Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
// The time the resource was created. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the resource was last updated. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
ProcessOptions *ProcessOptions `mandatory:"true" json:"processOptions"`
// Metadata about this specific object.
Description *string `mandatory:"false" json:"description"`
// A simple key-value pair that is applied without any predefined name, type, or scope. Exists
// for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Tags defined for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The system tags associated with this resource, if any. The system tags are set by Oracle
// Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more
// information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
// Describes the object's current state in detail. For example, it can be used to provide
// actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.
TimeLastRecorded *common.SDKTime `mandatory:"false" json:"timeLastRecorded"`
// Lifecycle state for the pipeline summary.
LifecycleState PipelineLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The Oracle license model that applies to a Deployment.
LicenseModel LicenseModelEnum `mandatory:"true" json:"licenseModel"`
// Possible lifecycle substates when retrieving a pipeline.
LifecycleSubState PipelineLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
}
func (m ZeroEtlPipelineSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ZeroEtlPipelineSummary) GetCpuCoreCount() *int
GetCpuCoreCount returns CpuCoreCount
func (m ZeroEtlPipelineSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ZeroEtlPipelineSummary) GetDescription() *string
GetDescription returns Description
func (m ZeroEtlPipelineSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m ZeroEtlPipelineSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ZeroEtlPipelineSummary) GetId() *string
GetId returns Id
func (m ZeroEtlPipelineSummary) GetIsAutoScalingEnabled() *bool
GetIsAutoScalingEnabled returns IsAutoScalingEnabled
func (m ZeroEtlPipelineSummary) GetLicenseModel() LicenseModelEnum
GetLicenseModel returns LicenseModel
func (m ZeroEtlPipelineSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m ZeroEtlPipelineSummary) GetLifecycleState() PipelineLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ZeroEtlPipelineSummary) GetLifecycleSubState() PipelineLifecycleSubStateEnum
GetLifecycleSubState returns LifecycleSubState
func (m ZeroEtlPipelineSummary) GetLocks() []ResourceLock
GetLocks returns Locks
func (m ZeroEtlPipelineSummary) GetSourceConnectionDetails() *SourcePipelineConnectionDetails
GetSourceConnectionDetails returns SourceConnectionDetails
func (m ZeroEtlPipelineSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m ZeroEtlPipelineSummary) GetTargetConnectionDetails() *TargetPipelineConnectionDetails
GetTargetConnectionDetails returns TargetConnectionDetails
func (m ZeroEtlPipelineSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ZeroEtlPipelineSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ZeroEtlPipelineSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ZeroEtlPipelineSummary) String() string
func (m ZeroEtlPipelineSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly