func GetAddResourceLockDetailsTypeEnumStringValues() []string
GetAddResourceLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddResourceLockDetailsTypeEnum
func GetConnectionResultEnumStringValues() []string
GetConnectionResultEnumStringValues Enumerates the set of values in String for ConnectionResultEnum
func GetCustomPropertyDataTypeEnumStringValues() []string
GetCustomPropertyDataTypeEnumStringValues Enumerates the set of values in String for CustomPropertyDataTypeEnum
func GetDataAssetImportExportTypeFilterEnumStringValues() []string
GetDataAssetImportExportTypeFilterEnumStringValues Enumerates the set of values in String for DataAssetImportExportTypeFilterEnum
func GetEventConfigStatusEnumStringValues() []string
GetEventConfigStatusEnumStringValues Enumerates the set of values in String for EventConfigStatusEnum
func GetFacetedSearchAggregationPropertyTypeEnumStringValues() []string
GetFacetedSearchAggregationPropertyTypeEnumStringValues Enumerates the set of values in String for FacetedSearchAggregationPropertyTypeEnum
func GetFacetedSearchSortRequestSortOrderEnumStringValues() []string
GetFacetedSearchSortRequestSortOrderEnumStringValues Enumerates the set of values in String for FacetedSearchSortRequestSortOrderEnum
func GetGetAttributeFieldsEnumStringValues() []string
GetGetAttributeFieldsEnumStringValues Enumerates the set of values in String for GetAttributeFieldsEnum
func GetGetAttributeTagFieldsEnumStringValues() []string
GetGetAttributeTagFieldsEnumStringValues Enumerates the set of values in String for GetAttributeTagFieldsEnum
func GetGetConnectionFieldsEnumStringValues() []string
GetGetConnectionFieldsEnumStringValues Enumerates the set of values in String for GetConnectionFieldsEnum
func GetGetCustomPropertyFieldsEnumStringValues() []string
GetGetCustomPropertyFieldsEnumStringValues Enumerates the set of values in String for GetCustomPropertyFieldsEnum
func GetGetDataAssetFieldsEnumStringValues() []string
GetGetDataAssetFieldsEnumStringValues Enumerates the set of values in String for GetDataAssetFieldsEnum
func GetGetDataAssetTagFieldsEnumStringValues() []string
GetGetDataAssetTagFieldsEnumStringValues Enumerates the set of values in String for GetDataAssetTagFieldsEnum
func GetGetEntityFieldsEnumStringValues() []string
GetGetEntityFieldsEnumStringValues Enumerates the set of values in String for GetEntityFieldsEnum
func GetGetEntityTagFieldsEnumStringValues() []string
GetGetEntityTagFieldsEnumStringValues Enumerates the set of values in String for GetEntityTagFieldsEnum
func GetGetFolderFieldsEnumStringValues() []string
GetGetFolderFieldsEnumStringValues Enumerates the set of values in String for GetFolderFieldsEnum
func GetGetFolderTagFieldsEnumStringValues() []string
GetGetFolderTagFieldsEnumStringValues Enumerates the set of values in String for GetFolderTagFieldsEnum
func GetGetGlossaryFieldsEnumStringValues() []string
GetGetGlossaryFieldsEnumStringValues Enumerates the set of values in String for GetGlossaryFieldsEnum
func GetGetJobDefinitionFieldsEnumStringValues() []string
GetGetJobDefinitionFieldsEnumStringValues Enumerates the set of values in String for GetJobDefinitionFieldsEnum
func GetGetJobExecutionFieldsEnumStringValues() []string
GetGetJobExecutionFieldsEnumStringValues Enumerates the set of values in String for GetJobExecutionFieldsEnum
func GetGetJobFieldsEnumStringValues() []string
GetGetJobFieldsEnumStringValues Enumerates the set of values in String for GetJobFieldsEnum
func GetGetJobLogFieldsEnumStringValues() []string
GetGetJobLogFieldsEnumStringValues Enumerates the set of values in String for GetJobLogFieldsEnum
func GetGetJobMetricsFieldsEnumStringValues() []string
GetGetJobMetricsFieldsEnumStringValues Enumerates the set of values in String for GetJobMetricsFieldsEnum
func GetGetNamespaceFieldsEnumStringValues() []string
GetGetNamespaceFieldsEnumStringValues Enumerates the set of values in String for GetNamespaceFieldsEnum
func GetGetPatternFieldsEnumStringValues() []string
GetGetPatternFieldsEnumStringValues Enumerates the set of values in String for GetPatternFieldsEnum
func GetGetTermFieldsEnumStringValues() []string
GetGetTermFieldsEnumStringValues Enumerates the set of values in String for GetTermFieldsEnum
func GetGetTermRelationshipFieldsEnumStringValues() []string
GetGetTermRelationshipFieldsEnumStringValues Enumerates the set of values in String for GetTermRelationshipFieldsEnum
func GetGetTypeFieldsEnumStringValues() []string
GetGetTypeFieldsEnumStringValues Enumerates the set of values in String for GetTypeFieldsEnum
func GetHarvestStatusEnumStringValues() []string
GetHarvestStatusEnumStringValues Enumerates the set of values in String for HarvestStatusEnum
func GetJobExecutionStateEnumStringValues() []string
GetJobExecutionStateEnumStringValues Enumerates the set of values in String for JobExecutionStateEnum
func GetJobLifecycleStateEnumStringValues() []string
GetJobLifecycleStateEnumStringValues Enumerates the set of values in String for JobLifecycleStateEnum
func GetJobScheduleTypeEnumStringValues() []string
GetJobScheduleTypeEnumStringValues Enumerates the set of values in String for JobScheduleTypeEnum
func GetJobTypeEnumStringValues() []string
GetJobTypeEnumStringValues Enumerates the set of values in String for JobTypeEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetLineageDirectionEnumStringValues() []string
GetLineageDirectionEnumStringValues Enumerates the set of values in String for LineageDirectionEnum
func GetListAggregatedPhysicalEntitiesFieldsEnumStringValues() []string
GetListAggregatedPhysicalEntitiesFieldsEnumStringValues Enumerates the set of values in String for ListAggregatedPhysicalEntitiesFieldsEnum
func GetListAggregatedPhysicalEntitiesSortByEnumStringValues() []string
GetListAggregatedPhysicalEntitiesSortByEnumStringValues Enumerates the set of values in String for ListAggregatedPhysicalEntitiesSortByEnum
func GetListAggregatedPhysicalEntitiesSortOrderEnumStringValues() []string
GetListAggregatedPhysicalEntitiesSortOrderEnumStringValues Enumerates the set of values in String for ListAggregatedPhysicalEntitiesSortOrderEnum
func GetListAttributeTagsFieldsEnumStringValues() []string
GetListAttributeTagsFieldsEnumStringValues Enumerates the set of values in String for ListAttributeTagsFieldsEnum
func GetListAttributeTagsLifecycleStateEnumStringValues() []string
GetListAttributeTagsLifecycleStateEnumStringValues Enumerates the set of values in String for ListAttributeTagsLifecycleStateEnum
func GetListAttributeTagsSortByEnumStringValues() []string
GetListAttributeTagsSortByEnumStringValues Enumerates the set of values in String for ListAttributeTagsSortByEnum
func GetListAttributeTagsSortOrderEnumStringValues() []string
GetListAttributeTagsSortOrderEnumStringValues Enumerates the set of values in String for ListAttributeTagsSortOrderEnum
func GetListAttributesFieldsEnumStringValues() []string
GetListAttributesFieldsEnumStringValues Enumerates the set of values in String for ListAttributesFieldsEnum
func GetListAttributesLifecycleStateEnumStringValues() []string
GetListAttributesLifecycleStateEnumStringValues Enumerates the set of values in String for ListAttributesLifecycleStateEnum
func GetListAttributesSortByEnumStringValues() []string
GetListAttributesSortByEnumStringValues Enumerates the set of values in String for ListAttributesSortByEnum
func GetListAttributesSortOrderEnumStringValues() []string
GetListAttributesSortOrderEnumStringValues Enumerates the set of values in String for ListAttributesSortOrderEnum
func GetListCatalogPrivateEndpointsLifecycleStateEnumStringValues() []string
GetListCatalogPrivateEndpointsLifecycleStateEnumStringValues Enumerates the set of values in String for ListCatalogPrivateEndpointsLifecycleStateEnum
func GetListCatalogPrivateEndpointsSortByEnumStringValues() []string
GetListCatalogPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListCatalogPrivateEndpointsSortByEnum
func GetListCatalogPrivateEndpointsSortOrderEnumStringValues() []string
GetListCatalogPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListCatalogPrivateEndpointsSortOrderEnum
func GetListCatalogsLifecycleStateEnumStringValues() []string
GetListCatalogsLifecycleStateEnumStringValues Enumerates the set of values in String for ListCatalogsLifecycleStateEnum
func GetListCatalogsSortByEnumStringValues() []string
GetListCatalogsSortByEnumStringValues Enumerates the set of values in String for ListCatalogsSortByEnum
func GetListCatalogsSortOrderEnumStringValues() []string
GetListCatalogsSortOrderEnumStringValues Enumerates the set of values in String for ListCatalogsSortOrderEnum
func GetListConnectionsFieldsEnumStringValues() []string
GetListConnectionsFieldsEnumStringValues Enumerates the set of values in String for ListConnectionsFieldsEnum
func GetListConnectionsLifecycleStateEnumStringValues() []string
GetListConnectionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListConnectionsLifecycleStateEnum
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 GetListCustomPropertiesFieldsEnumStringValues() []string
GetListCustomPropertiesFieldsEnumStringValues Enumerates the set of values in String for ListCustomPropertiesFieldsEnum
func GetListCustomPropertiesLifecycleStateEnumStringValues() []string
GetListCustomPropertiesLifecycleStateEnumStringValues Enumerates the set of values in String for ListCustomPropertiesLifecycleStateEnum
func GetListCustomPropertiesSortByEnumStringValues() []string
GetListCustomPropertiesSortByEnumStringValues Enumerates the set of values in String for ListCustomPropertiesSortByEnum
func GetListCustomPropertiesSortOrderEnumStringValues() []string
GetListCustomPropertiesSortOrderEnumStringValues Enumerates the set of values in String for ListCustomPropertiesSortOrderEnum
func GetListCustomPropertiesTypeNameEnumStringValues() []string
GetListCustomPropertiesTypeNameEnumStringValues Enumerates the set of values in String for ListCustomPropertiesTypeNameEnum
func GetListDataAssetTagsFieldsEnumStringValues() []string
GetListDataAssetTagsFieldsEnumStringValues Enumerates the set of values in String for ListDataAssetTagsFieldsEnum
func GetListDataAssetTagsLifecycleStateEnumStringValues() []string
GetListDataAssetTagsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDataAssetTagsLifecycleStateEnum
func GetListDataAssetTagsSortByEnumStringValues() []string
GetListDataAssetTagsSortByEnumStringValues Enumerates the set of values in String for ListDataAssetTagsSortByEnum
func GetListDataAssetTagsSortOrderEnumStringValues() []string
GetListDataAssetTagsSortOrderEnumStringValues Enumerates the set of values in String for ListDataAssetTagsSortOrderEnum
func GetListDataAssetsFieldsEnumStringValues() []string
GetListDataAssetsFieldsEnumStringValues Enumerates the set of values in String for ListDataAssetsFieldsEnum
func GetListDataAssetsLifecycleStateEnumStringValues() []string
GetListDataAssetsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDataAssetsLifecycleStateEnum
func GetListDataAssetsSortByEnumStringValues() []string
GetListDataAssetsSortByEnumStringValues Enumerates the set of values in String for ListDataAssetsSortByEnum
func GetListDataAssetsSortOrderEnumStringValues() []string
GetListDataAssetsSortOrderEnumStringValues Enumerates the set of values in String for ListDataAssetsSortOrderEnum
func GetListDerivedLogicalEntitiesSortByEnumStringValues() []string
GetListDerivedLogicalEntitiesSortByEnumStringValues Enumerates the set of values in String for ListDerivedLogicalEntitiesSortByEnum
func GetListDerivedLogicalEntitiesSortOrderEnumStringValues() []string
GetListDerivedLogicalEntitiesSortOrderEnumStringValues Enumerates the set of values in String for ListDerivedLogicalEntitiesSortOrderEnum
func GetListEntitiesFieldsEnumStringValues() []string
GetListEntitiesFieldsEnumStringValues Enumerates the set of values in String for ListEntitiesFieldsEnum
func GetListEntitiesHarvestStatusEnumStringValues() []string
GetListEntitiesHarvestStatusEnumStringValues Enumerates the set of values in String for ListEntitiesHarvestStatusEnum
func GetListEntitiesLifecycleStateEnumStringValues() []string
GetListEntitiesLifecycleStateEnumStringValues Enumerates the set of values in String for ListEntitiesLifecycleStateEnum
func GetListEntitiesSortByEnumStringValues() []string
GetListEntitiesSortByEnumStringValues Enumerates the set of values in String for ListEntitiesSortByEnum
func GetListEntitiesSortOrderEnumStringValues() []string
GetListEntitiesSortOrderEnumStringValues Enumerates the set of values in String for ListEntitiesSortOrderEnum
func GetListEntityTagsFieldsEnumStringValues() []string
GetListEntityTagsFieldsEnumStringValues Enumerates the set of values in String for ListEntityTagsFieldsEnum
func GetListEntityTagsLifecycleStateEnumStringValues() []string
GetListEntityTagsLifecycleStateEnumStringValues Enumerates the set of values in String for ListEntityTagsLifecycleStateEnum
func GetListEntityTagsSortByEnumStringValues() []string
GetListEntityTagsSortByEnumStringValues Enumerates the set of values in String for ListEntityTagsSortByEnum
func GetListEntityTagsSortOrderEnumStringValues() []string
GetListEntityTagsSortOrderEnumStringValues Enumerates the set of values in String for ListEntityTagsSortOrderEnum
func GetListFolderTagsFieldsEnumStringValues() []string
GetListFolderTagsFieldsEnumStringValues Enumerates the set of values in String for ListFolderTagsFieldsEnum
func GetListFolderTagsLifecycleStateEnumStringValues() []string
GetListFolderTagsLifecycleStateEnumStringValues Enumerates the set of values in String for ListFolderTagsLifecycleStateEnum
func GetListFolderTagsSortByEnumStringValues() []string
GetListFolderTagsSortByEnumStringValues Enumerates the set of values in String for ListFolderTagsSortByEnum
func GetListFolderTagsSortOrderEnumStringValues() []string
GetListFolderTagsSortOrderEnumStringValues Enumerates the set of values in String for ListFolderTagsSortOrderEnum
func GetListFoldersFieldsEnumStringValues() []string
GetListFoldersFieldsEnumStringValues Enumerates the set of values in String for ListFoldersFieldsEnum
func GetListFoldersHarvestStatusEnumStringValues() []string
GetListFoldersHarvestStatusEnumStringValues Enumerates the set of values in String for ListFoldersHarvestStatusEnum
func GetListFoldersLifecycleStateEnumStringValues() []string
GetListFoldersLifecycleStateEnumStringValues Enumerates the set of values in String for ListFoldersLifecycleStateEnum
func GetListFoldersSortByEnumStringValues() []string
GetListFoldersSortByEnumStringValues Enumerates the set of values in String for ListFoldersSortByEnum
func GetListFoldersSortOrderEnumStringValues() []string
GetListFoldersSortOrderEnumStringValues Enumerates the set of values in String for ListFoldersSortOrderEnum
func GetListGlossariesFieldsEnumStringValues() []string
GetListGlossariesFieldsEnumStringValues Enumerates the set of values in String for ListGlossariesFieldsEnum
func GetListGlossariesLifecycleStateEnumStringValues() []string
GetListGlossariesLifecycleStateEnumStringValues Enumerates the set of values in String for ListGlossariesLifecycleStateEnum
func GetListGlossariesSortByEnumStringValues() []string
GetListGlossariesSortByEnumStringValues Enumerates the set of values in String for ListGlossariesSortByEnum
func GetListGlossariesSortOrderEnumStringValues() []string
GetListGlossariesSortOrderEnumStringValues Enumerates the set of values in String for ListGlossariesSortOrderEnum
func GetListJobDefinitionsFieldsEnumStringValues() []string
GetListJobDefinitionsFieldsEnumStringValues Enumerates the set of values in String for ListJobDefinitionsFieldsEnum
func GetListJobDefinitionsJobExecutionStateEnumStringValues() []string
GetListJobDefinitionsJobExecutionStateEnumStringValues Enumerates the set of values in String for ListJobDefinitionsJobExecutionStateEnum
func GetListJobDefinitionsJobTypeEnumStringValues() []string
GetListJobDefinitionsJobTypeEnumStringValues Enumerates the set of values in String for ListJobDefinitionsJobTypeEnum
func GetListJobDefinitionsLifecycleStateEnumStringValues() []string
GetListJobDefinitionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListJobDefinitionsLifecycleStateEnum
func GetListJobDefinitionsSortByEnumStringValues() []string
GetListJobDefinitionsSortByEnumStringValues Enumerates the set of values in String for ListJobDefinitionsSortByEnum
func GetListJobDefinitionsSortOrderEnumStringValues() []string
GetListJobDefinitionsSortOrderEnumStringValues Enumerates the set of values in String for ListJobDefinitionsSortOrderEnum
func GetListJobExecutionsFieldsEnumStringValues() []string
GetListJobExecutionsFieldsEnumStringValues Enumerates the set of values in String for ListJobExecutionsFieldsEnum
func GetListJobExecutionsJobTypeEnumStringValues() []string
GetListJobExecutionsJobTypeEnumStringValues Enumerates the set of values in String for ListJobExecutionsJobTypeEnum
func GetListJobExecutionsLifecycleStateEnumStringValues() []string
GetListJobExecutionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListJobExecutionsLifecycleStateEnum
func GetListJobExecutionsSortByEnumStringValues() []string
GetListJobExecutionsSortByEnumStringValues Enumerates the set of values in String for ListJobExecutionsSortByEnum
func GetListJobExecutionsSortOrderEnumStringValues() []string
GetListJobExecutionsSortOrderEnumStringValues Enumerates the set of values in String for ListJobExecutionsSortOrderEnum
func GetListJobLogsFieldsEnumStringValues() []string
GetListJobLogsFieldsEnumStringValues Enumerates the set of values in String for ListJobLogsFieldsEnum
func GetListJobLogsLifecycleStateEnumStringValues() []string
GetListJobLogsLifecycleStateEnumStringValues Enumerates the set of values in String for ListJobLogsLifecycleStateEnum
func GetListJobLogsSortByEnumStringValues() []string
GetListJobLogsSortByEnumStringValues Enumerates the set of values in String for ListJobLogsSortByEnum
func GetListJobLogsSortOrderEnumStringValues() []string
GetListJobLogsSortOrderEnumStringValues Enumerates the set of values in String for ListJobLogsSortOrderEnum
func GetListJobMetricsFieldsEnumStringValues() []string
GetListJobMetricsFieldsEnumStringValues Enumerates the set of values in String for ListJobMetricsFieldsEnum
func GetListJobMetricsSortByEnumStringValues() []string
GetListJobMetricsSortByEnumStringValues Enumerates the set of values in String for ListJobMetricsSortByEnum
func GetListJobMetricsSortOrderEnumStringValues() []string
GetListJobMetricsSortOrderEnumStringValues Enumerates the set of values in String for ListJobMetricsSortOrderEnum
func GetListJobsFieldsEnumStringValues() []string
GetListJobsFieldsEnumStringValues Enumerates the set of values in String for ListJobsFieldsEnum
func GetListJobsJobTypeEnumStringValues() []string
GetListJobsJobTypeEnumStringValues Enumerates the set of values in String for ListJobsJobTypeEnum
func GetListJobsLifecycleStateEnumStringValues() []string
GetListJobsLifecycleStateEnumStringValues Enumerates the set of values in String for ListJobsLifecycleStateEnum
func GetListJobsScheduleTypeEnumStringValues() []string
GetListJobsScheduleTypeEnumStringValues Enumerates the set of values in String for ListJobsScheduleTypeEnum
func GetListJobsSortByEnumStringValues() []string
GetListJobsSortByEnumStringValues Enumerates the set of values in String for ListJobsSortByEnum
func GetListJobsSortOrderEnumStringValues() []string
GetListJobsSortOrderEnumStringValues Enumerates the set of values in String for ListJobsSortOrderEnum
func GetListMetastoresLifecycleStateEnumStringValues() []string
GetListMetastoresLifecycleStateEnumStringValues Enumerates the set of values in String for ListMetastoresLifecycleStateEnum
func GetListMetastoresSortByEnumStringValues() []string
GetListMetastoresSortByEnumStringValues Enumerates the set of values in String for ListMetastoresSortByEnum
func GetListMetastoresSortOrderEnumStringValues() []string
GetListMetastoresSortOrderEnumStringValues Enumerates the set of values in String for ListMetastoresSortOrderEnum
func GetListNamespacesFieldsEnumStringValues() []string
GetListNamespacesFieldsEnumStringValues Enumerates the set of values in String for ListNamespacesFieldsEnum
func GetListNamespacesLifecycleStateEnumStringValues() []string
GetListNamespacesLifecycleStateEnumStringValues Enumerates the set of values in String for ListNamespacesLifecycleStateEnum
func GetListNamespacesSortByEnumStringValues() []string
GetListNamespacesSortByEnumStringValues Enumerates the set of values in String for ListNamespacesSortByEnum
func GetListNamespacesSortOrderEnumStringValues() []string
GetListNamespacesSortOrderEnumStringValues Enumerates the set of values in String for ListNamespacesSortOrderEnum
func GetListPatternsFieldsEnumStringValues() []string
GetListPatternsFieldsEnumStringValues Enumerates the set of values in String for ListPatternsFieldsEnum
func GetListPatternsLifecycleStateEnumStringValues() []string
GetListPatternsLifecycleStateEnumStringValues Enumerates the set of values in String for ListPatternsLifecycleStateEnum
func GetListPatternsSortByEnumStringValues() []string
GetListPatternsSortByEnumStringValues Enumerates the set of values in String for ListPatternsSortByEnum
func GetListPatternsSortOrderEnumStringValues() []string
GetListPatternsSortOrderEnumStringValues Enumerates the set of values in String for ListPatternsSortOrderEnum
func GetListRulesFieldsEnumStringValues() []string
GetListRulesFieldsEnumStringValues Enumerates the set of values in String for ListRulesFieldsEnum
func GetListRulesLifecycleStateEnumStringValues() []string
GetListRulesLifecycleStateEnumStringValues Enumerates the set of values in String for ListRulesLifecycleStateEnum
func GetListRulesOriginTypeEnumStringValues() []string
GetListRulesOriginTypeEnumStringValues Enumerates the set of values in String for ListRulesOriginTypeEnum
func GetListRulesRuleTypeEnumStringValues() []string
GetListRulesRuleTypeEnumStringValues Enumerates the set of values in String for ListRulesRuleTypeEnum
func GetListRulesSortByEnumStringValues() []string
GetListRulesSortByEnumStringValues Enumerates the set of values in String for ListRulesSortByEnum
func GetListRulesSortOrderEnumStringValues() []string
GetListRulesSortOrderEnumStringValues Enumerates the set of values in String for ListRulesSortOrderEnum
func GetListTagsFieldsEnumStringValues() []string
GetListTagsFieldsEnumStringValues Enumerates the set of values in String for ListTagsFieldsEnum
func GetListTagsLifecycleStateEnumStringValues() []string
GetListTagsLifecycleStateEnumStringValues Enumerates the set of values in String for ListTagsLifecycleStateEnum
func GetListTagsSortByEnumStringValues() []string
GetListTagsSortByEnumStringValues Enumerates the set of values in String for ListTagsSortByEnum
func GetListTagsSortOrderEnumStringValues() []string
GetListTagsSortOrderEnumStringValues Enumerates the set of values in String for ListTagsSortOrderEnum
func GetListTermRelationshipsFieldsEnumStringValues() []string
GetListTermRelationshipsFieldsEnumStringValues Enumerates the set of values in String for ListTermRelationshipsFieldsEnum
func GetListTermRelationshipsLifecycleStateEnumStringValues() []string
GetListTermRelationshipsLifecycleStateEnumStringValues Enumerates the set of values in String for ListTermRelationshipsLifecycleStateEnum
func GetListTermRelationshipsSortByEnumStringValues() []string
GetListTermRelationshipsSortByEnumStringValues Enumerates the set of values in String for ListTermRelationshipsSortByEnum
func GetListTermRelationshipsSortOrderEnumStringValues() []string
GetListTermRelationshipsSortOrderEnumStringValues Enumerates the set of values in String for ListTermRelationshipsSortOrderEnum
func GetListTermsFieldsEnumStringValues() []string
GetListTermsFieldsEnumStringValues Enumerates the set of values in String for ListTermsFieldsEnum
func GetListTermsLifecycleStateEnumStringValues() []string
GetListTermsLifecycleStateEnumStringValues Enumerates the set of values in String for ListTermsLifecycleStateEnum
func GetListTermsSortByEnumStringValues() []string
GetListTermsSortByEnumStringValues Enumerates the set of values in String for ListTermsSortByEnum
func GetListTermsSortOrderEnumStringValues() []string
GetListTermsSortOrderEnumStringValues Enumerates the set of values in String for ListTermsSortOrderEnum
func GetListTermsWorkflowStatusEnumStringValues() []string
GetListTermsWorkflowStatusEnumStringValues Enumerates the set of values in String for ListTermsWorkflowStatusEnum
func GetListTypesFieldsEnumStringValues() []string
GetListTypesFieldsEnumStringValues Enumerates the set of values in String for ListTypesFieldsEnum
func GetListTypesLifecycleStateEnumStringValues() []string
GetListTypesLifecycleStateEnumStringValues Enumerates the set of values in String for ListTypesLifecycleStateEnum
func GetListTypesSortByEnumStringValues() []string
GetListTypesSortByEnumStringValues Enumerates the set of values in String for ListTypesSortByEnum
func GetListTypesSortOrderEnumStringValues() []string
GetListTypesSortOrderEnumStringValues Enumerates the set of values in String for ListTypesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetObjectStatsSortByEnumStringValues() []string
GetObjectStatsSortByEnumStringValues Enumerates the set of values in String for ObjectStatsSortByEnum
func GetObjectStatsSortOrderEnumStringValues() []string
GetObjectStatsSortOrderEnumStringValues Enumerates the set of values in String for ObjectStatsSortOrderEnum
func GetRecommendationResourceTypeEnumStringValues() []string
GetRecommendationResourceTypeEnumStringValues Enumerates the set of values in String for RecommendationResourceTypeEnum
func GetRecommendationStatusEnumStringValues() []string
GetRecommendationStatusEnumStringValues Enumerates the set of values in String for RecommendationStatusEnum
func GetRecommendationTypeEnumStringValues() []string
GetRecommendationTypeEnumStringValues Enumerates the set of values in String for RecommendationTypeEnum
func GetRecommendationsRecommendationStatusEnumStringValues() []string
GetRecommendationsRecommendationStatusEnumStringValues Enumerates the set of values in String for RecommendationsRecommendationStatusEnum
func GetRecommendationsSourceObjectTypeEnumStringValues() []string
GetRecommendationsSourceObjectTypeEnumStringValues Enumerates the set of values in String for RecommendationsSourceObjectTypeEnum
func GetRemoveResourceLockDetailsTypeEnumStringValues() []string
GetRemoveResourceLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveResourceLockDetailsTypeEnum
func GetResourceLockTypeEnumStringValues() []string
GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum
func GetRuleOriginTypeEnumStringValues() []string
GetRuleOriginTypeEnumStringValues Enumerates the set of values in String for RuleOriginTypeEnum
func GetRuleTypeEnumStringValues() []string
GetRuleTypeEnumStringValues Enumerates the set of values in String for RuleTypeEnum
func GetSearchCriteriaLifecycleStateEnumStringValues() []string
GetSearchCriteriaLifecycleStateEnumStringValues Enumerates the set of values in String for SearchCriteriaLifecycleStateEnum
func GetSearchCriteriaSortByEnumStringValues() []string
GetSearchCriteriaSortByEnumStringValues Enumerates the set of values in String for SearchCriteriaSortByEnum
func GetSearchCriteriaSortOrderEnumStringValues() []string
GetSearchCriteriaSortOrderEnumStringValues Enumerates the set of values in String for SearchCriteriaSortOrderEnum
func GetTermWorkflowStatusEnumStringValues() []string
GetTermWorkflowStatusEnumStringValues Enumerates the set of values in String for TermWorkflowStatusEnum
func GetUsersSortByEnumStringValues() []string
GetUsersSortByEnumStringValues Enumerates the set of values in String for UsersSortByEnum
func GetUsersSortOrderEnumStringValues() []string
GetUsersSortOrderEnumStringValues Enumerates the set of values in String for UsersSortOrderEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
AddCatalogLockRequest wrapper for the AddCatalogLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddCatalogLock.go.html to see an example of how to use AddCatalogLockRequest.
type AddCatalogLockRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// 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 AddCatalogLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddCatalogLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddCatalogLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddCatalogLockRequest) String() string
func (request AddCatalogLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddCatalogLockResponse wrapper for the AddCatalogLock operation
type AddCatalogLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Catalog instance
Catalog `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 Catalog resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response AddCatalogLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddCatalogLockResponse) String() string
AddCatalogPrivateEndpointLockRequest wrapper for the AddCatalogPrivateEndpointLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddCatalogPrivateEndpointLock.go.html to see an example of how to use AddCatalogPrivateEndpointLockRequest.
type AddCatalogPrivateEndpointLockRequest struct {
// Unique private reverse connection identifier.
CatalogPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"catalogPrivateEndpointId"`
// 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 AddCatalogPrivateEndpointLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddCatalogPrivateEndpointLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddCatalogPrivateEndpointLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddCatalogPrivateEndpointLockRequest) String() string
func (request AddCatalogPrivateEndpointLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddCatalogPrivateEndpointLockResponse wrapper for the AddCatalogPrivateEndpointLock operation
type AddCatalogPrivateEndpointLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The CatalogPrivateEndpoint instance
CatalogPrivateEndpoint `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 CatalogPrivateEndpoint resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response AddCatalogPrivateEndpointLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddCatalogPrivateEndpointLockResponse) String() string
AddDataSelectorPatternsRequest wrapper for the AddDataSelectorPatterns operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddDataSelectorPatterns.go.html to see an example of how to use AddDataSelectorPatternsRequest.
type AddDataSelectorPatternsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to add the patterns for deriving logical entities.
DataSelectorPatternDetails `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 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 AddDataSelectorPatternsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddDataSelectorPatternsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddDataSelectorPatternsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddDataSelectorPatternsRequest) String() string
func (request AddDataSelectorPatternsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddDataSelectorPatternsResponse wrapper for the AddDataSelectorPatterns operation
type AddDataSelectorPatternsResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataAsset instance
DataAsset `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response AddDataSelectorPatternsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddDataSelectorPatternsResponse) String() string
AddMetastoreLockRequest wrapper for the AddMetastoreLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddMetastoreLock.go.html to see an example of how to use AddMetastoreLockRequest.
type AddMetastoreLockRequest struct {
// The metastore's OCID.
MetastoreId *string `mandatory:"true" contributesTo:"path" name:"metastoreId"`
// 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 AddMetastoreLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddMetastoreLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddMetastoreLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddMetastoreLockRequest) String() string
func (request AddMetastoreLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AddMetastoreLockResponse wrapper for the AddMetastoreLock operation
type AddMetastoreLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Metastore instance
Metastore `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 Metastore resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response AddMetastoreLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddMetastoreLockResponse) String() string
AddResourceLockDetails The representation of AddResourceLockDetails
type AddResourceLockDetails struct {
// Type of the lock.
Type AddResourceLockDetailsTypeEnum `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 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
AssociateCustomPropertyRequest wrapper for the AssociateCustomProperty operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AssociateCustomProperty.go.html to see an example of how to use AssociateCustomPropertyRequest.
type AssociateCustomPropertyRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique type key.
TypeKey *string `mandatory:"true" contributesTo:"path" name:"typeKey"`
// The information used to associate the custom property for the type.
AssociateCustomPropertyDetails TypeCustomPropertyDetails `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 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 AssociateCustomPropertyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AssociateCustomPropertyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AssociateCustomPropertyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AssociateCustomPropertyRequest) String() string
func (request AssociateCustomPropertyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AssociateCustomPropertyResponse wrapper for the AssociateCustomProperty operation
type AssociateCustomPropertyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ModelType instance
ModelType `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response AssociateCustomPropertyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AssociateCustomPropertyResponse) String() string
AsynchronousExportDataAssetDetails Details needed by the Data Asset export request.
type AsynchronousExportDataAssetDetails struct {
ObjectStorageTarget *ObjectStorageObjectReference `mandatory:"false" json:"objectStorageTarget"`
// Array of objects and their child types to be selected for export.
ExportScope []DataAssetExportScope `mandatory:"false" json:"exportScope"`
}
func (m AsynchronousExportDataAssetDetails) String() string
func (m AsynchronousExportDataAssetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AsynchronousExportDataAssetRequest wrapper for the AsynchronousExportDataAsset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AsynchronousExportDataAsset.go.html to see an example of how to use AsynchronousExportDataAssetRequest.
type AsynchronousExportDataAssetRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Details needed by the Data Asset export request.
AsynchronousExportDataAssetDetails `contributesTo:"body"`
// Type of export.
ExportType []DataAssetImportExportTypeFilterEnum `contributesTo:"query" name:"exportType" omitEmpty:"true" collectionFormat:"multi"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 AsynchronousExportDataAssetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AsynchronousExportDataAssetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AsynchronousExportDataAssetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AsynchronousExportDataAssetRequest) String() string
func (request AsynchronousExportDataAssetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AsynchronousExportDataAssetResponse wrapper for the AsynchronousExportDataAsset operation
type AsynchronousExportDataAssetResponse struct {
// The underlying http response
RawResponse *http.Response
// The AsynchronousExportDataAssetResult instance
AsynchronousExportDataAssetResult `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"`
}
func (response AsynchronousExportDataAssetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AsynchronousExportDataAssetResponse) String() string
AsynchronousExportDataAssetResult Details about the job which performs an export.
type AsynchronousExportDataAssetResult struct {
// Display name of the export job.
JobDefinitionName *string `mandatory:"false" json:"jobDefinitionName"`
// Unique key of the export job definition.
JobDefinitionKey *string `mandatory:"false" json:"jobDefinitionKey"`
// Unique key of the export job.
JobKey *string `mandatory:"false" json:"jobKey"`
// Unique key of the job execution.
JobExecutionKey *string `mandatory:"false" json:"jobExecutionKey"`
// Unique key of the object being exported.
SourceKey *string `mandatory:"false" json:"sourceKey"`
}
func (m AsynchronousExportDataAssetResult) String() string
func (m AsynchronousExportDataAssetResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AsynchronousExportGlossaryDetails Details needed by the glossary export request.
type AsynchronousExportGlossaryDetails struct {
ObjectStorageTarget *ObjectStorageObjectReference `mandatory:"false" json:"objectStorageTarget"`
}
func (m AsynchronousExportGlossaryDetails) String() string
func (m AsynchronousExportGlossaryDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AsynchronousExportGlossaryRequest wrapper for the AsynchronousExportGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AsynchronousExportGlossary.go.html to see an example of how to use AsynchronousExportGlossaryRequest.
type AsynchronousExportGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Details needed by the glossary export request.
AsynchronousExportGlossaryDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 AsynchronousExportGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AsynchronousExportGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AsynchronousExportGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AsynchronousExportGlossaryRequest) String() string
func (request AsynchronousExportGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AsynchronousExportGlossaryResponse wrapper for the AsynchronousExportGlossary operation
type AsynchronousExportGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// The AsynchronousExportGlossaryResult instance
AsynchronousExportGlossaryResult `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response AsynchronousExportGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AsynchronousExportGlossaryResponse) String() string
AsynchronousExportGlossaryResult Details about the job which performs an export.
type AsynchronousExportGlossaryResult struct {
// Display name of the export job.
JobDefinitionName *string `mandatory:"false" json:"jobDefinitionName"`
// Unique key of the export job definition.
JobDefinitionKey *string `mandatory:"false" json:"jobDefinitionKey"`
// Unique key of the export job.
JobKey *string `mandatory:"false" json:"jobKey"`
// Unique key of the job execution.
JobExecutionKey *string `mandatory:"false" json:"jobExecutionKey"`
// Unique key of the object being exported.
SourceKey *string `mandatory:"false" json:"sourceKey"`
}
func (m AsynchronousExportGlossaryResult) String() string
func (m AsynchronousExportGlossaryResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AsynchronousExportRequestDetails Details for an export request.
type AsynchronousExportRequestDetails struct {
ObjectStorageTarget *ObjectStorageObjectReference `mandatory:"false" json:"objectStorageTarget"`
}
func (m AsynchronousExportRequestDetails) String() string
func (m AsynchronousExportRequestDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AsynchronousExportResult Details about the job which performs an export.
type AsynchronousExportResult struct {
// Display name of the export job.
JobDefinitionName *string `mandatory:"false" json:"jobDefinitionName"`
// Unique key of the export job definition.
JobDefinitionKey *string `mandatory:"false" json:"jobDefinitionKey"`
// Unique key of the export job.
JobKey *string `mandatory:"false" json:"jobKey"`
// Unique key of the job execution.
JobExecutionKey *string `mandatory:"false" json:"jobExecutionKey"`
// Unique key of the object being exported.
SourceKey *string `mandatory:"false" json:"sourceKey"`
}
func (m AsynchronousExportResult) String() string
func (m AsynchronousExportResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttachCatalogPrivateEndpointDetails Information about the attaching the private endpoint resource to a catalog
type AttachCatalogPrivateEndpointDetails struct {
// The identifier of the private endpoint to be attached to the catalog resource.
CatalogPrivateEndpointId *string `mandatory:"true" json:"catalogPrivateEndpointId"`
}
func (m AttachCatalogPrivateEndpointDetails) String() string
func (m AttachCatalogPrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttachCatalogPrivateEndpointRequest wrapper for the AttachCatalogPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AttachCatalogPrivateEndpoint.go.html to see an example of how to use AttachCatalogPrivateEndpointRequest.
type AttachCatalogPrivateEndpointRequest struct {
// Details for private reverse connection endpoint to be used for attachment.
AttachCatalogPrivateEndpointDetails `contributesTo:"body"`
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// 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"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 AttachCatalogPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AttachCatalogPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AttachCatalogPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AttachCatalogPrivateEndpointRequest) String() string
func (request AttachCatalogPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttachCatalogPrivateEndpointResponse wrapper for the AttachCatalogPrivateEndpoint operation
type AttachCatalogPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response AttachCatalogPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AttachCatalogPrivateEndpointResponse) String() string
Attribute Details of an entity attribute. An attribute of a data entity describing an item of data, with a name and data type. Synonymous with 'column' in a database.
type Attribute struct {
// Unique attribute key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of the attribute.
Description *string `mandatory:"false" json:"description"`
// The unique key of the parent entity.
EntityKey *string `mandatory:"false" json:"entityKey"`
// State of the attribute.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time the attribute was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the attribute. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created this attribute in the data catalog.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who modified this attribute in the data catalog.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Data type of the attribute as defined in the external system. Type mapping across systems can be achieved
// through term associations across domains in the ontology. The attribute can also be tagged to the datatype in
// the domain ontology to resolve any ambiguity arising from type name similarity that can occur with user
// defined types.
ExternalDataType *string `mandatory:"false" json:"externalDataType"`
// Unique external key of this attribute in the external source system.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Property that identifies if this attribute can be used as a watermark to extract incremental data.
IsIncrementalData *bool `mandatory:"false" json:"isIncrementalData"`
// Property that identifies if this attribute can be assigned null values.
IsNullable *bool `mandatory:"false" json:"isNullable"`
// The type of the attribute. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
MinCollectionCount *int `mandatory:"false" json:"minCollectionCount"`
// The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
// For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".
// Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json
MaxCollectionCount *int `mandatory:"false" json:"maxCollectionCount"`
// Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
DatatypeEntityKey *string `mandatory:"false" json:"datatypeEntityKey"`
// External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
ExternalDatatypeEntityKey *string `mandatory:"false" json:"externalDatatypeEntityKey"`
// Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
ParentAttributeKey *string `mandatory:"false" json:"parentAttributeKey"`
// External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
ExternalParentAttributeKey *string `mandatory:"false" json:"externalParentAttributeKey"`
// Max allowed length of the attribute value.
Length *int64 `mandatory:"false" json:"length"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" json:"position"`
// Precision of the attribute value usually applies to float data type.
Precision *int `mandatory:"false" json:"precision"`
// Scale of the attribute value usually applies to float data type.
Scale *int `mandatory:"false" json:"scale"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// The date and time the attribute was harvested, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeHarvested *common.SDKTime `mandatory:"false" json:"timeHarvested"`
// List of objects and their relationships to this attribute.
ObjectRelationships []ObjectRelationship `mandatory:"false" json:"objectRelationships"`
// Whether a column is derived or not.
IsDerivedAttribute *bool `mandatory:"false" json:"isDerivedAttribute"`
// URI to the attribute instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Full path of the attribute.
Path *string `mandatory:"false" json:"path"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the attribute type. Each attribute type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// attributes have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
// Rule types associated with attribute.
AssociatedRuleTypes []RuleTypeEnum `mandatory:"false" json:"associatedRuleTypes,omitempty"`
}
func (m Attribute) String() string
func (m Attribute) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttributeCollection Results of an attributes listing. Attributes describe an item of data with name and datatype.
type AttributeCollection struct {
// Collection of attributes.
Items []AttributeSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m AttributeCollection) String() string
func (m AttributeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttributeSummary Summary of an entity attribute.
type AttributeSummary struct {
// Unique attribute key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of the attribute.
Description *string `mandatory:"false" json:"description"`
// The unique key of the parent entity.
EntityKey *string `mandatory:"false" json:"entityKey"`
// Unique external key of this attribute in the external source system.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Max allowed length of the attribute value.
Length *int64 `mandatory:"false" json:"length"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" json:"position"`
// Precision of the attribute value usually applies to float data type.
Precision *int `mandatory:"false" json:"precision"`
// Scale of the attribute value usually applies to float data type.
Scale *int `mandatory:"false" json:"scale"`
// Property that identifies if this attribute can be assigned null values.
IsNullable *bool `mandatory:"false" json:"isNullable"`
// URI to the attribute instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// State of the attribute.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time the attribute was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Data type of the attribute as defined in the external source system.
ExternalDataType *string `mandatory:"false" json:"externalDataType"`
// The type of the attribute. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
MinCollectionCount *int `mandatory:"false" json:"minCollectionCount"`
// The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
// For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".
// Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json
MaxCollectionCount *int `mandatory:"false" json:"maxCollectionCount"`
// Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
DatatypeEntityKey *string `mandatory:"false" json:"datatypeEntityKey"`
// External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
ExternalDatatypeEntityKey *string `mandatory:"false" json:"externalDatatypeEntityKey"`
// Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
ParentAttributeKey *string `mandatory:"false" json:"parentAttributeKey"`
// External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
ExternalParentAttributeKey *string `mandatory:"false" json:"externalParentAttributeKey"`
// Full path of the attribute.
Path *string `mandatory:"false" json:"path"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// Rule types associated with attribute.
AssociatedRuleTypes []RuleTypeEnum `mandatory:"false" json:"associatedRuleTypes,omitempty"`
// Whether a column is derived or not.
IsDerivedAttribute *bool `mandatory:"false" json:"isDerivedAttribute"`
// The last time that any change was made to the attribute. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A map of maps that contains the properties which are specific to the attribute type. Each attribute type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// attributes have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m AttributeSummary) String() string
func (m AttributeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttributeTag Represents an association of an entity attribute to a term.
type AttributeTag struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Name of the tag which matches the term name.
Name *string `mandatory:"false" json:"name"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// The current state of the tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// OCID of the user who created the tag.
CreatedById *string `mandatory:"false" json:"createdById"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The unique key of the parent attribute.
AttributeKey *string `mandatory:"false" json:"attributeKey"`
}
func (m AttributeTag) String() string
func (m AttributeTag) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttributeTagCollection Results of an attribute tags listing. Attribnute tags allow association of business terms with attributes.
type AttributeTagCollection struct {
// Collection of attribute tags.
Items []AttributeTagSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m AttributeTagCollection) String() string
func (m AttributeTagCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AttributeTagSummary Summary of an entity attribute tag.
type AttributeTagSummary struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Name of the tag that matches the term name.
Name *string `mandatory:"false" json:"name"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// Unique id of the parent glossary of the term.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// State of the Tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The unique key of the parent attribute.
AttributeKey *string `mandatory:"false" json:"attributeKey"`
}
func (m AttributeTagSummary) String() string
func (m AttributeTagSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BasePermissionsSummary Permissions object sent as part of the response.
type BasePermissionsSummary struct {
// An array of permissions.
UserPermissions []string `mandatory:"false" json:"userPermissions"`
}
func (m BasePermissionsSummary) String() string
func (m BasePermissionsSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BaseTag Represents the association of an object to a term. Tags are immutable.
type BaseTag struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Name of the tag which matches the term name.
Name *string `mandatory:"false" json:"name"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// The current state of the tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// OCID of the user who created the tag.
CreatedById *string `mandatory:"false" json:"createdById"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
}
func (m BaseTag) String() string
func (m BaseTag) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BaseTagSummary Represents the association of an object to a term.
type BaseTagSummary struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Name of the tag that matches the term name.
Name *string `mandatory:"false" json:"name"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// Unique id of the parent glossary of the term.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// State of the Tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m BaseTagSummary) String() string
func (m BaseTagSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Catalog A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.
type Catalog struct {
// OCID of the data catalog instance.
Id *string `mandatory:"true" json:"id"`
// Compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Data catalog identifier, which can be renamed.
DisplayName *string `mandatory:"false" json:"displayName"`
// The time the data catalog was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the data catalog was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The REST front endpoint URL to the data catalog instance.
ServiceApiUrl *string `mandatory:"false" json:"serviceApiUrl"`
// The console front endpoint URL to the data catalog instance.
ServiceConsoleUrl *string `mandatory:"false" json:"serviceConsoleUrl"`
// The number of data objects added to the data catalog.
// Please see the data catalog documentation for further information on how this is calculated.
NumberOfObjects *int `mandatory:"false" json:"numberOfObjects"`
// The current state of the data catalog resource.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// An message describing the current state in more detail.
// For example, it can be used to provide actionable information for a resource in 'Failed' state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// System tags can be viewed by users, but can only be created by the system.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The list of private reverse connection endpoints attached to the catalog
AttachedCatalogPrivateEndpoints []string `mandatory:"false" json:"attachedCatalogPrivateEndpoints"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m Catalog) String() string
func (m Catalog) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CatalogPermissionsSummary General permissions object.
type CatalogPermissionsSummary struct {
// An array of permissions.
UserPermissions []string `mandatory:"false" json:"userPermissions"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
}
func (m CatalogPermissionsSummary) String() string
func (m CatalogPermissionsSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CatalogPrivateEndpoint A private network reverse connection creates a connection from service to customer subnet over a private network.
type CatalogPrivateEndpoint struct {
// Unique identifier that is immutable
Id *string `mandatory:"true" json:"id"`
// Compartment Identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Subnet Identifier
SubnetId *string `mandatory:"true" json:"subnetId"`
// List of DNS zones to be used by the data assets to be harvested.
// Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
DnsZones []string `mandatory:"true" json:"dnsZones"`
// Private Reverse Connection Endpoint display name
DisplayName *string `mandatory:"false" json:"displayName"`
// The time the private endpoint was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the private endpoint was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// System tags can be viewed by users, but can only be created by the system.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The current state of the private endpoint resource.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The list of catalogs using the private reverse connection endpoint
AttachedCatalogs []string `mandatory:"false" json:"attachedCatalogs"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m CatalogPrivateEndpoint) String() string
func (m CatalogPrivateEndpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CatalogPrivateEndpointSummary A private network reverse connection creates a connection from service to customer subnet over a private network.
type CatalogPrivateEndpointSummary struct {
// Unique identifier that is immutable
Id *string `mandatory:"true" json:"id"`
// Subnet Identifier
SubnetId *string `mandatory:"true" json:"subnetId"`
// List of DNS zones to be used by the data assets to be harvested.
// Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
DnsZones []string `mandatory:"true" json:"dnsZones"`
// Identifier of the compartment this private endpoint belongs to
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the private endpoint was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the private endpoint was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Mutable name of the Private Reverse Connection Endpoint
DisplayName *string `mandatory:"false" json:"displayName"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// System tags can be viewed by users, but can only be created by the system.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The current state of the private endpoint resource.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The list of catalogs using the private reverse connection endpoint
AttachedCatalogs []string `mandatory:"false" json:"attachedCatalogs"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m CatalogPrivateEndpointSummary) String() string
func (m CatalogPrivateEndpointSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CatalogSummary Summary of the data catalog.
type CatalogSummary struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// Compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Data catalog identifier, that can be renamed.
DisplayName *string `mandatory:"false" json:"displayName"`
// The time the data catalog was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the data catalog was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The number of high level objects added to the data catalog.
NumberOfObjects *int `mandatory:"false" json:"numberOfObjects"`
// The current state of the data catalog resource.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// System tags can be viewed by users, but can only be created by the system.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The list of private reverse connection endpoints attached to the catalog
AttachedCatalogPrivateEndpoints []string `mandatory:"false" json:"attachedCatalogPrivateEndpoints"`
// Locks associated with this resource.
Locks []ResourceLock `mandatory:"false" json:"locks"`
}
func (m CatalogSummary) String() string
func (m CatalogSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeCatalogCompartmentDetails Information about the change compartment
type ChangeCatalogCompartmentDetails struct {
// The identifier of the compartment where the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCatalogCompartmentDetails) String() string
func (m ChangeCatalogCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeCatalogCompartmentRequest wrapper for the ChangeCatalogCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ChangeCatalogCompartment.go.html to see an example of how to use ChangeCatalogCompartmentRequest.
type ChangeCatalogCompartmentRequest struct {
// Details for the target compartment.
ChangeCatalogCompartmentDetails `contributesTo:"body"`
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// 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"`
// 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 ChangeCatalogCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeCatalogCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeCatalogCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeCatalogCompartmentRequest) String() string
func (request ChangeCatalogCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeCatalogCompartmentResponse wrapper for the ChangeCatalogCompartment operation
type ChangeCatalogCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeCatalogCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeCatalogCompartmentResponse) String() string
ChangeCatalogPrivateEndpointCompartmentDetails Information about the change compartment for the private endpoint resource
type ChangeCatalogPrivateEndpointCompartmentDetails struct {
// The identifier of the compartment where the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCatalogPrivateEndpointCompartmentDetails) String() string
func (m ChangeCatalogPrivateEndpointCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeCatalogPrivateEndpointCompartmentRequest wrapper for the ChangeCatalogPrivateEndpointCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ChangeCatalogPrivateEndpointCompartment.go.html to see an example of how to use ChangeCatalogPrivateEndpointCompartmentRequest.
type ChangeCatalogPrivateEndpointCompartmentRequest struct {
// Details for the target compartment.
ChangeCatalogPrivateEndpointCompartmentDetails `contributesTo:"body"`
// Unique private reverse connection identifier.
CatalogPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"catalogPrivateEndpointId"`
// 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"`
// 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 ChangeCatalogPrivateEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeCatalogPrivateEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeCatalogPrivateEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeCatalogPrivateEndpointCompartmentRequest) String() string
func (request ChangeCatalogPrivateEndpointCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeCatalogPrivateEndpointCompartmentResponse wrapper for the ChangeCatalogPrivateEndpointCompartment operation
type ChangeCatalogPrivateEndpointCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeCatalogPrivateEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeCatalogPrivateEndpointCompartmentResponse) String() string
ChangeMetastoreCompartmentDetails Information about a change in metastore compartment.
type ChangeMetastoreCompartmentDetails struct {
// OCID of the compartment to which the metastore should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeMetastoreCompartmentDetails) String() string
func (m ChangeMetastoreCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeMetastoreCompartmentRequest wrapper for the ChangeMetastoreCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ChangeMetastoreCompartment.go.html to see an example of how to use ChangeMetastoreCompartmentRequest.
type ChangeMetastoreCompartmentRequest struct {
// Information about a change in metastore compartment.
ChangeMetastoreCompartmentDetails `contributesTo:"body"`
// The metastore's OCID.
MetastoreId *string `mandatory:"true" contributesTo:"path" name:"metastoreId"`
// 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"`
// 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 ChangeMetastoreCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeMetastoreCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeMetastoreCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeMetastoreCompartmentRequest) String() string
func (request ChangeMetastoreCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeMetastoreCompartmentResponse wrapper for the ChangeMetastoreCompartment operation
type ChangeMetastoreCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeMetastoreCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeMetastoreCompartmentResponse) String() string
Connection Detailed representation of a connection to a data asset, minus any sensitive properties.
type Connection struct {
// Unique connection key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A description of the connection.
Description *string `mandatory:"false" json:"description"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the connection was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the connection. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the connection.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who modified the connection.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the connection type. Each connection type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// connections have required properties within the "default" category.
// Example: `{"properties": { "default": { "username": "user1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
// Unique external key of this object from the source system.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Time that the connections status was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStatusUpdated *common.SDKTime `mandatory:"false" json:"timeStatusUpdated"`
// The current state of the connection.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates whether this connection is the default connection.
IsDefault *bool `mandatory:"false" json:"isDefault"`
// Unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// The key of the object type. Type key's can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// URI to the connection instance in the API.
Uri *string `mandatory:"false" json:"uri"`
}
func (m Connection) String() string
func (m Connection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectionAliasSummary Summary representation of database aliases parsed from the file metadata.
type ConnectionAliasSummary struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
AliasName *string `mandatory:"true" json:"aliasName"`
// The description about the database alias parsed from the file metadata.
AliasDetails *string `mandatory:"false" json:"aliasDetails"`
}
func (m ConnectionAliasSummary) String() string
func (m ConnectionAliasSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an 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 Results of a connections listing. Each member of the result is a summary representation of a connection to a data asset.
type ConnectionCollection struct {
// Collection of connection summaries.
Items []ConnectionSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m ConnectionCollection) String() string
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
ConnectionResultEnum Enum with underlying type: string
type ConnectionResultEnum string
Set of constants representing the allowable values for ConnectionResultEnum
const (
ConnectionResultSucceeded ConnectionResultEnum = "SUCCEEDED"
ConnectionResultFailed ConnectionResultEnum = "FAILED"
)
func GetConnectionResultEnumValues() []ConnectionResultEnum
GetConnectionResultEnumValues Enumerates the set of values for ConnectionResultEnum
func GetMappingConnectionResultEnum(val string) (ConnectionResultEnum, bool)
GetMappingConnectionResultEnum performs case Insensitive comparison on enum value and return the desired enum
ConnectionSummary Summary representation of a connection to a data asset.
type ConnectionSummary struct {
// Unique connection key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A description of the connection.
Description *string `mandatory:"false" json:"description"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// The key of the object type. Type key's can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// URI to the connection instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Unique external key for this object as defined in the source systems.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// The current state of the connection.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates whether this connection is the default connection.
IsDefault *bool `mandatory:"false" json:"isDefault"`
// The date and time the connection was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m ConnectionSummary) String() string
func (m ConnectionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAttributeDetails Properties used in attribute create operations.
type CreateAttributeDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Data type of the attribute as defined in the external system.
ExternalDataType *string `mandatory:"true" json:"externalDataType"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"true" json:"timeExternal"`
// Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of the attribute.
Description *string `mandatory:"false" json:"description"`
// Property that identifies if this attribute can be used as a watermark to extract incremental data.
IsIncrementalData *bool `mandatory:"false" json:"isIncrementalData"`
// Property that identifies if this attribute can be assigned null values.
IsNullable *bool `mandatory:"false" json:"isNullable"`
// Max allowed length of the attribute value.
Length *int64 `mandatory:"false" json:"length"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" json:"position"`
// Precision of the attribute value usually applies to float data type.
Precision *int `mandatory:"false" json:"precision"`
// Scale of the attribute value usually applies to float data type.
Scale *int `mandatory:"false" json:"scale"`
// The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
MinCollectionCount *int `mandatory:"false" json:"minCollectionCount"`
// The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
// For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".
// Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json
MaxCollectionCount *int `mandatory:"false" json:"maxCollectionCount"`
// External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
ExternalDatatypeEntityKey *string `mandatory:"false" json:"externalDatatypeEntityKey"`
// External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
ExternalParentAttributeKey *string `mandatory:"false" json:"externalParentAttributeKey"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// Type key of the object. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// A map of maps that contains the properties which are specific to the attribute type. Each attribute type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// attributes have required properties within the "default" category. To determine the set of required and
// optional properties for an attribute type, a query can be done on '/types?type=attribute' that returns a
// collection of all attribute types. The appropriate attribute type, which will include definitions of all
// of it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CreateAttributeDetails) String() string
func (m CreateAttributeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAttributeRequest wrapper for the CreateAttribute operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateAttribute.go.html to see an example of how to use CreateAttributeRequest.
type CreateAttributeRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// The information used to create an entity attribute.
CreateAttributeDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateAttributeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAttributeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAttributeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAttributeRequest) String() string
func (request CreateAttributeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAttributeResponse wrapper for the CreateAttribute operation
type CreateAttributeResponse struct {
// The underlying http response
RawResponse *http.Response
// The Attribute instance
Attribute `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateAttributeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAttributeResponse) String() string
CreateAttributeTagRequest wrapper for the CreateAttributeTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateAttributeTag.go.html to see an example of how to use CreateAttributeTagRequest.
type CreateAttributeTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique attribute key.
AttributeKey *string `mandatory:"true" contributesTo:"path" name:"attributeKey"`
// The information used to create an entity attribute tag.
CreateAttributeTagDetails CreateTagDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateAttributeTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAttributeTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAttributeTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAttributeTagRequest) String() string
func (request CreateAttributeTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateAttributeTagResponse wrapper for the CreateAttributeTag operation
type CreateAttributeTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The AttributeTag instance
AttributeTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateAttributeTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAttributeTagResponse) String() string
CreateCatalogDetails The information about a new data catalog.
type CreateCatalogDetails struct {
// Compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Data catalog identifier.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateCatalogDetails) String() string
func (m CreateCatalogDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCatalogPrivateEndpointDetails Information about the new private endpoint resource
type CreateCatalogPrivateEndpointDetails struct {
// List of DNS zones to be used by the data assets to be harvested.
// Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
DnsZones []string `mandatory:"true" json:"dnsZones"`
// The OCID of subnet to which the reverse connection is to be created
SubnetId *string `mandatory:"true" json:"subnetId"`
// Compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Display name of the private endpoint resource being created.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m CreateCatalogPrivateEndpointDetails) String() string
func (m CreateCatalogPrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCatalogPrivateEndpointRequest wrapper for the CreateCatalogPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateCatalogPrivateEndpoint.go.html to see an example of how to use CreateCatalogPrivateEndpointRequest.
type CreateCatalogPrivateEndpointRequest struct {
// The information used to create the private reverse connection.
CreateCatalogPrivateEndpointDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateCatalogPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCatalogPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCatalogPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCatalogPrivateEndpointRequest) String() string
func (request CreateCatalogPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCatalogPrivateEndpointResponse wrapper for the CreateCatalogPrivateEndpoint operation
type CreateCatalogPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateCatalogPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCatalogPrivateEndpointResponse) String() string
CreateCatalogRequest wrapper for the CreateCatalog operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateCatalog.go.html to see an example of how to use CreateCatalogRequest.
type CreateCatalogRequest struct {
// Details for the new data catalog.
CreateCatalogDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCatalogRequest) String() string
func (request CreateCatalogRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCatalogResponse wrapper for the CreateCatalog operation
type CreateCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response CreateCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCatalogResponse) String() string
CreateConnectionDetails Properties used in connection create operations.
type CreateConnectionDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The key of the object type. Type key's can be found via the '/types' endpoint.
TypeKey *string `mandatory:"true" json:"typeKey"`
// A map of maps that contains the properties which are specific to the connection type. Each connection type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// connections have required properties within the "default" category. To determine the set of optional and
// required properties for a connection type, a query can be done on '/types?type=connection' that returns a
// collection of all connection types. The appropriate connection type, which will include definitions of all
// of it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "username": "user1"}}}`
Properties map[string]map[string]string `mandatory:"true" json:"properties"`
// A description of the connection.
Description *string `mandatory:"false" json:"description"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the encrypted values for sensitive properties which are specific to the
// connection type. Each connection type definition defines it's set of required and optional properties.
// The map keys are category names and the values are maps of property name to property value. Every property is
// contained inside of a category. Most connections have required properties within the "default" category.
// To determine the set of optional and required properties for a connection type, a query can be done
// on '/types?type=connection' that returns a collection of all connection types. The appropriate connection
// type, which will include definitions of all of it's properties, can be identified from this collection.
// Example: `{"encProperties": { "default": { "password": "example-password"}}}`
EncProperties map[string]map[string]string `mandatory:"false" json:"encProperties"`
// Indicates whether this connection is the default connection. The first connection of a data asset defaults
// to being the default, subsequent connections default to not being the default. If a default connection already
// exists, then trying to create a connection as the default will fail. In this case the default connection would
// need to be updated not to be the default and then the new connection can then be created as the default.
IsDefault *bool `mandatory:"false" json:"isDefault"`
}
func (m CreateConnectionDetails) String() string
func (m CreateConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConnectionRequest wrapper for the CreateConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateConnection.go.html to see an example of how to use CreateConnectionRequest.
type CreateConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to create the connection.
CreateConnectionDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 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"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConnectionResponse) String() string
CreateCustomPropertyDetails Properties used in custom property create operations.
type CreateCustomPropertyDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Detailed description of the custom property.
Description *string `mandatory:"false" json:"description"`
// The data type of the custom property
DataType CustomPropertyDataTypeEnum `mandatory:"false" json:"dataType,omitempty"`
// If this field allows to sort from UI
IsSortable *bool `mandatory:"false" json:"isSortable"`
// If this field allows to filter or create facets from UI
IsFilterable *bool `mandatory:"false" json:"isFilterable"`
// If this field allows multiple values to be set
IsMultiValued *bool `mandatory:"false" json:"isMultiValued"`
// If this field is a hidden field
IsHidden *bool `mandatory:"false" json:"isHidden"`
// If this field is a editable field
IsEditable *bool `mandatory:"false" json:"isEditable"`
// If this field is displayed in a list view of applicable objects.
IsShownInList *bool `mandatory:"false" json:"isShownInList"`
// If this field is allowed to pop in search results
IsHiddenInSearch *bool `mandatory:"false" json:"isHiddenInSearch"`
// If an OCI Event will be emitted when the custom property is modified.
IsEventEnabled *bool `mandatory:"false" json:"isEventEnabled"`
// Allowed values for the custom property if any
AllowedValues []string `mandatory:"false" json:"allowedValues"`
// A map of maps that contains the properties which are specific to the data asset type. Each data asset type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data assets have required properties within the "default" category. To determine the set of optional and
// required properties for a data asset type, a query can be done on '/types?type=dataAsset' that returns a
// collection of all data asset types. The appropriate data asset type, which includes definitions of all of
// it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CreateCustomPropertyDetails) String() string
func (m CreateCustomPropertyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCustomPropertyRequest wrapper for the CreateCustomProperty operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateCustomProperty.go.html to see an example of how to use CreateCustomPropertyRequest.
type CreateCustomPropertyRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// The information used to create the Custom Property.
CreateCustomPropertyDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateCustomPropertyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCustomPropertyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCustomPropertyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCustomPropertyRequest) String() string
func (request CreateCustomPropertyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCustomPropertyResponse wrapper for the CreateCustomProperty operation
type CreateCustomPropertyResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomProperty instance
CustomProperty `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateCustomPropertyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCustomPropertyResponse) String() string
CreateDataAssetDetails Properties used in data asset create operations.
type CreateDataAssetDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The key of the data asset type. This can be obtained via the '/types' endpoint.
TypeKey *string `mandatory:"true" json:"typeKey"`
// Detailed description of the data asset.
Description *string `mandatory:"false" json:"description"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the data asset type. Each data asset type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data assets have required properties within the "default" category. To determine the set of optional and
// required properties for a data asset type, a query can be done on '/types?type=dataAsset' that returns a
// collection of all data asset types. The appropriate data asset type, which includes definitions of all of
// it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CreateDataAssetDetails) String() string
func (m CreateDataAssetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDataAssetRequest wrapper for the CreateDataAsset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateDataAsset.go.html to see an example of how to use CreateDataAssetRequest.
type CreateDataAssetRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The information used to create the data asset.
CreateDataAssetDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateDataAssetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDataAssetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDataAssetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDataAssetRequest) String() string
func (request CreateDataAssetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDataAssetResponse wrapper for the CreateDataAsset operation
type CreateDataAssetResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataAsset instance
DataAsset `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateDataAssetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDataAssetResponse) String() string
CreateDataAssetTagRequest wrapper for the CreateDataAssetTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateDataAssetTag.go.html to see an example of how to use CreateDataAssetTagRequest.
type CreateDataAssetTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to create the data asset tag.
CreateDataAssetTagDetails CreateTagDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateDataAssetTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDataAssetTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDataAssetTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDataAssetTagRequest) String() string
func (request CreateDataAssetTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDataAssetTagResponse wrapper for the CreateDataAssetTag operation
type CreateDataAssetTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataAssetTag instance
DataAssetTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateDataAssetTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDataAssetTagResponse) String() string
CreateEntityDetails Properties used in data entity create operations.
type CreateEntityDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Last modified timestamp of the object in the external system.
TimeExternal *common.SDKTime `mandatory:"true" json:"timeExternal"`
// Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// The type of data entity object. Type key's can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// Detailed description of a data entity.
Description *string `mandatory:"false" json:"description"`
// Property to indicate if the object is a physical materialized object or virtual. For example, View.
IsLogical *bool `mandatory:"false" json:"isLogical"`
// Property to indicate if the object is a sub object of a parent physical object.
IsPartition *bool `mandatory:"false" json:"isPartition"`
// Key of the associated folder.
FolderKey *string `mandatory:"false" json:"folderKey"`
// Key of the associated pattern if this is a logical entity.
PatternKey *string `mandatory:"false" json:"patternKey"`
// The expression realized after resolving qualifiers . Used in deriving this logical entity
RealizedExpression *string `mandatory:"false" json:"realizedExpression"`
// Status of the object as updated by the harvest process. When an entity object is created , it's harvest status
// will indicate if the entity's metadata has been fully harvested or not. The harvest process can perform
// shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object
// This requires a harvest status indicator for catalog objects.
HarvestStatus HarvestStatusEnum `mandatory:"false" json:"harvestStatus,omitempty"`
// Key of the last harvest process to update this object.
LastJobKey *string `mandatory:"false" json:"lastJobKey"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the entity type. Each entity type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// entities have required properties within the "default" category. To determine the set of required and
// optional properties for an entity type, a query can be done on '/types?type=dataEntity' that returns a
// collection of all entity types. The appropriate entity type, which includes definitions of all of
// it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CreateEntityDetails) String() string
func (m CreateEntityDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateEntityRequest wrapper for the CreateEntity operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateEntity.go.html to see an example of how to use CreateEntityRequest.
type CreateEntityRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to create the data entity.
CreateEntityDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateEntityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateEntityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateEntityRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateEntityRequest) String() string
func (request CreateEntityRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateEntityResponse wrapper for the CreateEntity operation
type CreateEntityResponse struct {
// The underlying http response
RawResponse *http.Response
// The Entity instance
Entity `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateEntityResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateEntityResponse) String() string
CreateEntityTagRequest wrapper for the CreateEntityTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateEntityTag.go.html to see an example of how to use CreateEntityTagRequest.
type CreateEntityTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// The information used to create the entity tag.
CreateEntityTagDetails CreateTagDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateEntityTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateEntityTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateEntityTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateEntityTagRequest) String() string
func (request CreateEntityTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateEntityTagResponse wrapper for the CreateEntityTag operation
type CreateEntityTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The EntityTag instance
EntityTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateEntityTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateEntityTagResponse) String() string
CreateFolderDetails Properties used in folder create operations.
type CreateFolderDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"true" json:"timeExternal"`
// Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of a folder.
Description *string `mandatory:"false" json:"description"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the folder type. Each folder type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// folders have required properties within the "default" category. To determine the set of optional and
// required properties for a folder type, a query can be done on '/types?type=folder' that returns a
// collection of all folder types. The appropriate folder type, which includes definitions of all of
// it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
// The key of the containing folder or null if there isn't a parent folder.
ParentFolderKey *string `mandatory:"false" json:"parentFolderKey"`
// The job key of the harvest process that updated the folder definition from the source system.
LastJobKey *string `mandatory:"false" json:"lastJobKey"`
// Folder harvesting status.
HarvestStatus HarvestStatusEnum `mandatory:"false" json:"harvestStatus,omitempty"`
// Type key of the object. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
}
func (m CreateFolderDetails) String() string
func (m CreateFolderDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateFolderRequest wrapper for the CreateFolder operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateFolder.go.html to see an example of how to use CreateFolderRequest.
type CreateFolderRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to create the folder.
CreateFolderDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateFolderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateFolderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateFolderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateFolderRequest) String() string
func (request CreateFolderRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateFolderResponse wrapper for the CreateFolder operation
type CreateFolderResponse struct {
// The underlying http response
RawResponse *http.Response
// The Folder instance
Folder `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateFolderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateFolderResponse) String() string
CreateFolderTagRequest wrapper for the CreateFolderTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateFolderTag.go.html to see an example of how to use CreateFolderTagRequest.
type CreateFolderTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique folder key.
FolderKey *string `mandatory:"true" contributesTo:"path" name:"folderKey"`
// The information used to create the folder tag.
CreateFolderTagDetails CreateTagDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateFolderTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateFolderTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateFolderTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateFolderTagRequest) String() string
func (request CreateFolderTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateFolderTagResponse wrapper for the CreateFolderTag operation
type CreateFolderTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The FolderTag instance
FolderTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateFolderTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateFolderTagResponse) String() string
CreateGlossaryDetails Properties used in glossary create operations.
type CreateGlossaryDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Detailed description of the glossary.
Description *string `mandatory:"false" json:"description"`
// Status of the approval process workflow for this business glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// OCID of the user who is the owner of the glossary.
Owner *string `mandatory:"false" json:"owner"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
}
func (m CreateGlossaryDetails) String() string
func (m CreateGlossaryDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGlossaryRequest wrapper for the CreateGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateGlossary.go.html to see an example of how to use CreateGlossaryRequest.
type CreateGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The information used to create the glossary.
CreateGlossaryDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGlossaryRequest) String() string
func (request CreateGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGlossaryResponse wrapper for the CreateGlossary operation
type CreateGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// The Glossary instance
Glossary `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGlossaryResponse) String() string
CreateJobDefinitionDetails Representation of a job definition Resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.
type CreateJobDefinitionDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of the job definition.
JobType JobTypeEnum `mandatory:"true" json:"jobType"`
// Detailed description of the job definition.
Description *string `mandatory:"false" json:"description"`
// Specifies if the job definition is incremental or full.
IsIncremental *bool `mandatory:"false" json:"isIncremental"`
// The key of the data asset for which the job is defined.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// The key of the connection resource to be used for the job.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
// Specify if sample data to be extracted as part of this harvest.
IsSampleDataExtracted *bool `mandatory:"false" json:"isSampleDataExtracted"`
// Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
SampleDataSizeInMBs *int `mandatory:"false" json:"sampleDataSizeInMBs"`
// A map of maps that contains the properties which are specific to the job type. Each job type
// definition may define it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// job definitions have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CreateJobDefinitionDetails) String() string
func (m CreateJobDefinitionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateJobDefinitionRequest wrapper for the CreateJobDefinition operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateJobDefinition.go.html to see an example of how to use CreateJobDefinitionRequest.
type CreateJobDefinitionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The information used to create the job definition.
CreateJobDefinitionDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateJobDefinitionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateJobDefinitionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateJobDefinitionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateJobDefinitionRequest) String() string
func (request CreateJobDefinitionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateJobDefinitionResponse wrapper for the CreateJobDefinition operation
type CreateJobDefinitionResponse struct {
// The underlying http response
RawResponse *http.Response
// The JobDefinition instance
JobDefinition `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateJobDefinitionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateJobDefinitionResponse) String() string
CreateJobDetails Properties used to create a job.
type CreateJobDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The unique key of the job definition that defined the scope of this job.
JobDefinitionKey *string `mandatory:"true" json:"jobDefinitionKey"`
// Detailed description of the job.
Description *string `mandatory:"false" json:"description"`
// Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".
// The following subset of those is supported: @monthly, @weekly, @daily, @hourly.
// For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.
ScheduleCronExpression *string `mandatory:"false" json:"scheduleCronExpression"`
// Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleBegin *common.SDKTime `mandatory:"false" json:"timeScheduleBegin"`
// Date that the schedule should end from being operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleEnd *common.SDKTime `mandatory:"false" json:"timeScheduleEnd"`
// The key of the connection used by the job. This connection will override the default connection specified in
// the associated job definition. All executions will use this connection.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
}
func (m CreateJobDetails) String() string
func (m CreateJobDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateJobExecutionDetails Properties for creating a new job execution.
type CreateJobExecutionDetails struct {
// Sub-type of this job execution.
SubType *string `mandatory:"false" json:"subType"`
// Type of the job execution.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// The unique key of the parent execution or null if this job execution has no parent.
ParentKey *string `mandatory:"false" json:"parentKey"`
// Time that job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Time that the job execution ended or null if it hasn't yet completed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// Status of the job execution, such as running, paused, or completed.
LifecycleState JobExecutionStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Error code returned from the job execution or null if job is still running or didn't return an error.
ErrorCode *string `mandatory:"false" json:"errorCode"`
// Error message returned from the job execution or null if job is still running or didn't return an error.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
// The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
ScheduleInstanceKey *string `mandatory:"false" json:"scheduleInstanceKey"`
// Process identifier related to the job execution if the job is an external job.
ProcessKey *string `mandatory:"false" json:"processKey"`
// If the job is an external process, then a URL of the job for accessing this resource and its status.
ExternalUrl *string `mandatory:"false" json:"externalUrl"`
// An identifier used for log message correlation.
EventKey *string `mandatory:"false" json:"eventKey"`
// The key of the associated data entity resource.
DataEntityKey *string `mandatory:"false" json:"dataEntityKey"`
// A map of maps that contains the execution context properties which are specific to a job execution. Each job
// execution may define it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// job executions have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CreateJobExecutionDetails) String() string
func (m CreateJobExecutionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateJobExecutionRequest wrapper for the CreateJobExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateJobExecution.go.html to see an example of how to use CreateJobExecutionRequest.
type CreateJobExecutionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// The information used to create the job execution.
CreateJobExecutionDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateJobExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateJobExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateJobExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateJobExecutionRequest) String() string
func (request CreateJobExecutionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateJobExecutionResponse wrapper for the CreateJobExecution operation
type CreateJobExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// The JobExecution instance
JobExecution `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateJobExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateJobExecutionResponse) String() string
CreateJobRequest wrapper for the CreateJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateJob.go.html to see an example of how to use CreateJobRequest.
type CreateJobRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The information used to create the job.
CreateJobDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateJobRequest) String() string
func (request CreateJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateJobResponse wrapper for the CreateJob operation
type CreateJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The Job instance
Job `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateJobResponse) String() string
CreateMetastoreDetails Information about a new metastore.
type CreateMetastoreDetails struct {
// OCID of the compartment which holds the metastore.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Location under which managed tables will be created by default. This references Object Storage
// using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
DefaultManagedTableLocation *string `mandatory:"true" json:"defaultManagedTableLocation"`
// Location under which external tables will be created by default. This references Object Storage
// using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
DefaultExternalTableLocation *string `mandatory:"true" json:"defaultExternalTableLocation"`
// Mutable name of the metastore.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateMetastoreDetails) String() string
func (m CreateMetastoreDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMetastoreRequest wrapper for the CreateMetastore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateMetastore.go.html to see an example of how to use CreateMetastoreRequest.
type CreateMetastoreRequest struct {
// Information about a new metastore to be created.
CreateMetastoreDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateMetastoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateMetastoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateMetastoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateMetastoreRequest) String() string
func (request CreateMetastoreRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateMetastoreResponse wrapper for the CreateMetastore operation
type CreateMetastoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response CreateMetastoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateMetastoreResponse) String() string
CreateNamespaceDetails Properties used in custom property create operations.
type CreateNamespaceDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Detailed description of the Namespace.
Description *string `mandatory:"false" json:"description"`
// If this field is defined by service or by a user
IsServiceDefined *bool `mandatory:"false" json:"isServiceDefined"`
}
func (m CreateNamespaceDetails) String() string
func (m CreateNamespaceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateNamespaceRequest wrapper for the CreateNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateNamespace.go.html to see an example of how to use CreateNamespaceRequest.
type CreateNamespaceRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The information used to create the Namespace.
CreateNamespaceDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateNamespaceRequest) String() string
func (request CreateNamespaceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateNamespaceResponse wrapper for the CreateNamespace operation
type CreateNamespaceResponse struct {
// The underlying http response
RawResponse *http.Response
// The Namespace instance
Namespace `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateNamespaceResponse) String() string
CreatePatternDetails Properties used in pattern create operations.
type CreatePatternDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Detailed description of the Pattern.
Description *string `mandatory:"false" json:"description"`
// Input string which drives the selection process, allowing for fine-grained control using qualifiers.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
Expression *string `mandatory:"false" json:"expression"`
// Input string which drives the selection process.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
FilePathPrefix *string `mandatory:"false" json:"filePathPrefix"`
// List of file paths against which the pattern can be tried, as a check. This documents, for reference
// purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true,
// this will be run as a validation during the request, such that if the check fails the request fails. If
// isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even
// if the check fails, with a lifecycleState of FAILED.
CheckFilePathList []string `mandatory:"false" json:"checkFilePathList"`
// Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of
// UNMATCHED files is above the checkFailureLimit.
IsEnableCheckFailureLimit *bool `mandatory:"false" json:"isEnableCheckFailureLimit"`
// The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if
// checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.
CheckFailureLimit *int `mandatory:"false" json:"checkFailureLimit"`
// A map of maps that contains the properties which are specific to the pattern type. Each pattern type
// definition defines it's set of required and optional properties.
// Example: `{"properties": { "default": { "tbd"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CreatePatternDetails) String() string
func (m CreatePatternDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePatternRequest wrapper for the CreatePattern operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreatePattern.go.html to see an example of how to use CreatePatternRequest.
type CreatePatternRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The information used to create the pattern.
CreatePatternDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreatePatternRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePatternRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePatternRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePatternRequest) String() string
func (request CreatePatternRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePatternResponse wrapper for the CreatePattern operation
type CreatePatternResponse struct {
// The underlying http response
RawResponse *http.Response
// The Pattern instance
Pattern `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreatePatternResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePatternResponse) String() string
CreateTagDetails Properties used in tag create operations.
type CreateTagDetails struct {
// The name of the tag in the case of a free form tag.
// When linking to a glossary term, this field is not specified.
Name *string `mandatory:"false" json:"name"`
// Unique key of the related term or null in the case of a free form tag.
TermKey *string `mandatory:"false" json:"termKey"`
}
func (m CreateTagDetails) String() string
func (m CreateTagDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateTermDetails Properties used in term create operations.
type CreateTermDetails struct {
// A user-friendly display name. Is changeable. The combination of 'displayName' and 'parentTermKey'
// must be unique. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Detailed description of the term.
Description *string `mandatory:"false" json:"description"`
// Indicates whether a term may contain child terms.
IsAllowedToHaveChildTerms *bool `mandatory:"false" json:"isAllowedToHaveChildTerms"`
// The parent key of the term. In the case of a root-level category only, the term would have no parent and this should be left unset.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// OCID of the user who is the owner of this business terminology.
Owner *string `mandatory:"false" json:"owner"`
// Status of the approval process workflow for this business term in the glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
}
func (m CreateTermDetails) String() string
func (m CreateTermDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateTermRelationshipDetails Properties used in term relationship create operations.
type CreateTermRelationshipDetails struct {
// A user-friendly display name. Is changeable. The combination of 'displayName' and 'parentTermKey'
// must be unique. Avoid entering confidential information. This is the same as 'relationshipType' for 'termRelationship'.
DisplayName *string `mandatory:"true" json:"displayName"`
// Unique id of the related term.
RelatedTermKey *string `mandatory:"true" json:"relatedTermKey"`
// Detailed description of the term relationship usually defined at the time of creation.
Description *string `mandatory:"false" json:"description"`
}
func (m CreateTermRelationshipDetails) String() string
func (m CreateTermRelationshipDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateTermRelationshipRequest wrapper for the CreateTermRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateTermRelationship.go.html to see an example of how to use CreateTermRelationshipRequest.
type CreateTermRelationshipRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// The information used to create the term relationship.
CreateTermRelationshipDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateTermRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTermRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTermRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTermRelationshipRequest) String() string
func (request CreateTermRelationshipRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateTermRelationshipResponse wrapper for the CreateTermRelationship operation
type CreateTermRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// The TermRelationship instance
TermRelationship `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateTermRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTermRelationshipResponse) String() string
CreateTermRequest wrapper for the CreateTerm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateTerm.go.html to see an example of how to use CreateTermRequest.
type CreateTermRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// The information used to create the term.
CreateTermDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 CreateTermRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTermRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTermRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTermRequest) String() string
func (request CreateTermRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateTermResponse wrapper for the CreateTerm operation
type CreateTermResponse struct {
// The underlying http response
RawResponse *http.Response
// The Term instance
Term `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response CreateTermResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTermResponse) String() string
CustomProperty Custom Property Definition
type CustomProperty struct {
// Unique data asset key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Display name of the custom property
DisplayName *string `mandatory:"false" json:"displayName"`
// Data type of the custom property
DataType CustomPropertyDataTypeEnum `mandatory:"false" json:"dataType,omitempty"`
// Description for the custom property
Description *string `mandatory:"false" json:"description"`
// Namespace name of the custom property
NamespaceName *string `mandatory:"false" json:"namespaceName"`
// Is this property allowed to have list of values
IsListType *bool `mandatory:"false" json:"isListType"`
// If this field allows to sort from UI
IsSortable *bool `mandatory:"false" json:"isSortable"`
// If this field allows to filter or create facets from UI
IsFilterable *bool `mandatory:"false" json:"isFilterable"`
// If this field allows multiple values to be set
IsMultiValued *bool `mandatory:"false" json:"isMultiValued"`
// If this field is a hidden field
IsHidden *bool `mandatory:"false" json:"isHidden"`
// If this field is a editable field
IsEditable *bool `mandatory:"false" json:"isEditable"`
// If this field is displayed in a list view of applicable objects.
IsShownInList *bool `mandatory:"false" json:"isShownInList"`
// If this field is defined by service or by a user
IsServiceDefined *bool `mandatory:"false" json:"isServiceDefined"`
// If this field is allowed to pop in search results
IsHiddenInSearch *bool `mandatory:"false" json:"isHiddenInSearch"`
// The current state of the custom property.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the custom property was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the custom property. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the custom property.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who last modified the custom property.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Total number of first class objects using this custom property
UsageCount *int `mandatory:"false" json:"usageCount"`
// If an OCI Event will be emitted when the custom property is modified.
IsEventEnabled *bool `mandatory:"false" json:"isEventEnabled"`
// The set of object types to which the custom property applies.
Scope []CustomPropertyTypeUsage `mandatory:"false" json:"scope"`
// Allowed values for the custom property if any
AllowedValues []string `mandatory:"false" json:"allowedValues"`
// Event configuration for this custom property, against the desired subset of object types to which the property applies.
Events []EventConfig `mandatory:"false" json:"events"`
// A map of maps that contains the properties which are specific to the asset type. Each data asset type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data assets have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m CustomProperty) String() string
func (m CustomProperty) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomPropertyCollection Results of a custom properties listing. A custom property is an user defined attribute tied to the first class object of data catalog
type CustomPropertyCollection struct {
// Collection of custom property summaries
Items []CustomPropertySummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m CustomPropertyCollection) String() string
func (m CustomPropertyCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomPropertyDataTypeEnum Enum with underlying type: string
type CustomPropertyDataTypeEnum string
Set of constants representing the allowable values for CustomPropertyDataTypeEnum
const (
CustomPropertyDataTypeText CustomPropertyDataTypeEnum = "TEXT"
CustomPropertyDataTypeRichText CustomPropertyDataTypeEnum = "RICH_TEXT"
CustomPropertyDataTypeBoolean CustomPropertyDataTypeEnum = "BOOLEAN"
CustomPropertyDataTypeNumber CustomPropertyDataTypeEnum = "NUMBER"
CustomPropertyDataTypeDate CustomPropertyDataTypeEnum = "DATE"
)
func GetCustomPropertyDataTypeEnumValues() []CustomPropertyDataTypeEnum
GetCustomPropertyDataTypeEnumValues Enumerates the set of values for CustomPropertyDataTypeEnum
func GetMappingCustomPropertyDataTypeEnum(val string) (CustomPropertyDataTypeEnum, bool)
GetMappingCustomPropertyDataTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CustomPropertyGetUsage Details of a single custom property
type CustomPropertyGetUsage struct {
// Unique Identifier of the attribute which is ID
Key *string `mandatory:"false" json:"key"`
// Display name of the custom property
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the custom property
Description *string `mandatory:"false" json:"description"`
// The custom property value
Value *string `mandatory:"false" json:"value"`
// The data type of the custom property
DataType CustomPropertyDataTypeEnum `mandatory:"false" json:"dataType,omitempty"`
// Namespace name of the custom property
NamespaceName *string `mandatory:"false" json:"namespaceName"`
// Unique namespace key that is immutable
NamespaceKey *string `mandatory:"false" json:"namespaceKey"`
// If this field allows multiple values to be set
IsMultiValued *bool `mandatory:"false" json:"isMultiValued"`
// If this field is a hidden field
IsHidden *bool `mandatory:"false" json:"isHidden"`
// If this field is a editable field
IsEditable *bool `mandatory:"false" json:"isEditable"`
// If this field is displayed in a list view of applicable objects.
IsShownInList *bool `mandatory:"false" json:"isShownInList"`
// If an OCI Event will be emitted when the custom property is modified.
IsEventEnabled *bool `mandatory:"false" json:"isEventEnabled"`
// Is this property allowed to have list of values
IsListType *bool `mandatory:"false" json:"isListType"`
// Allowed values for the custom property if any
AllowedValues []string `mandatory:"false" json:"allowedValues"`
}
func (m CustomPropertyGetUsage) String() string
func (m CustomPropertyGetUsage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomPropertySetUsage Details of a single custom property.
type CustomPropertySetUsage struct {
// Unique Identifier of the attribute which is ID
Key *string `mandatory:"false" json:"key"`
// Name of the custom property
DisplayName *string `mandatory:"false" json:"displayName"`
// The custom property value
Value *string `mandatory:"false" json:"value"`
// Namespace name of the custom property
NamespaceName *string `mandatory:"false" json:"namespaceName"`
}
func (m CustomPropertySetUsage) String() string
func (m CustomPropertySetUsage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomPropertySummary Summary of a custom property
type CustomPropertySummary struct {
// Unique custom property key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Display name of the custom property
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the custom property
Description *string `mandatory:"false" json:"description"`
// Data type of the custom property
DataType CustomPropertyDataTypeEnum `mandatory:"false" json:"dataType,omitempty"`
// Namespace name of the custom property
NamespaceName *string `mandatory:"false" json:"namespaceName"`
// If this field allows to sort from UI
IsSortable *bool `mandatory:"false" json:"isSortable"`
// If this field allows to filter or create facets from UI
IsFilterable *bool `mandatory:"false" json:"isFilterable"`
// If this field allows multiple values to be set
IsMultiValued *bool `mandatory:"false" json:"isMultiValued"`
// If this field is a hidden field
IsHidden *bool `mandatory:"false" json:"isHidden"`
// If this field is a editable field
IsEditable *bool `mandatory:"false" json:"isEditable"`
// If this field is displayed in a list view of applicable objects.
IsShownInList *bool `mandatory:"false" json:"isShownInList"`
// If this field is defined by service or by a user
IsServiceDefined *bool `mandatory:"false" json:"isServiceDefined"`
// If this field is allowed to pop in search results
IsHiddenInSearch *bool `mandatory:"false" json:"isHiddenInSearch"`
// The date and time the custom property was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The current state of the custom property.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Total number of first class objects using this custom property
UsageCount *int `mandatory:"false" json:"usageCount"`
// Type or scope of the custom property belongs to. This will be an array of type id it will be belongs to
Scope []CustomPropertyTypeUsage `mandatory:"false" json:"scope"`
// Allowed values for the custom property if any
AllowedValues []string `mandatory:"false" json:"allowedValues"`
// The last time that any change was made to the custom property. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the custom property.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who last modified the custom property.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// If an OCI Event will be emitted when the custom property is modified.
IsEventEnabled *bool `mandatory:"false" json:"isEventEnabled"`
// Event configuration for this custom property, against the desired subset of object types to which the property applies.
Events []EventConfig `mandatory:"false" json:"events"`
}
func (m CustomPropertySummary) String() string
func (m CustomPropertySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomPropertyTypeUsage Object which describes the indivial object stats for every custom property
type CustomPropertyTypeUsage struct {
// Unique type key identifier
TypeId *string `mandatory:"false" json:"typeId"`
// Name of the type associated with
TypeName *string `mandatory:"false" json:"typeName"`
// Number of objects associated with this type
Count *int `mandatory:"false" json:"count"`
// If an OCI Event will be emitted when the custom property is modified.
IsEventEnabled *bool `mandatory:"false" json:"isEventEnabled"`
}
func (m CustomPropertyTypeUsage) String() string
func (m CustomPropertyTypeUsage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAsset Data asset representation. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized structure of folders. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.
type DataAsset struct {
// Unique data asset key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the data asset.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// External URI that can be used to reference the object. Format will differ based on the type of object.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// The key of the object type. Type key's can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// The current state of the data asset.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time the data asset was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the data asset. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The last time that a harvest was performed on the data asset. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeHarvested *common.SDKTime `mandatory:"false" json:"timeHarvested"`
// OCID of the user who created the data asset.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who last modified the data asset.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// URI to the data asset instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// The list of data selector patterns used in the harvest for this data asset to derive logical entities.
DataSelectorPatterns []PatternSummary `mandatory:"false" json:"dataSelectorPatterns"`
// A map of maps that contains the properties which are specific to the asset type. Each data asset type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data assets have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m DataAsset) String() string
func (m DataAsset) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAssetCollection Results of a data assets listing. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.
type DataAssetCollection struct {
// Collection of data asset summaries.
Items []DataAssetSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m DataAssetCollection) String() string
func (m DataAssetCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAssetExportScope Scope of asset export, which consists of a container object (bucket, folder, schema, etc) within the asset, and types of child objects contained by that object to be included.
objectKey - Key of the container object to be exported. For example, key of schema_1. exportTypeIds - Type key(s) of objects within the container object to be exported. For example, type key of table or view.
type DataAssetExportScope struct {
// Unique key of the object selected for export.
ObjectKey *string `mandatory:"false" json:"objectKey"`
// Array of type keys selected for export.
ExportTypeIds []string `mandatory:"false" json:"exportTypeIds"`
}
func (m DataAssetExportScope) String() string
func (m DataAssetExportScope) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAssetImportExportTypeFilterEnum Enum with underlying type: string
type DataAssetImportExportTypeFilterEnum string
Set of constants representing the allowable values for DataAssetImportExportTypeFilterEnum
const (
DataAssetImportExportTypeFilterCustomPropertyValues DataAssetImportExportTypeFilterEnum = "CUSTOM_PROPERTY_VALUES"
DataAssetImportExportTypeFilterAll DataAssetImportExportTypeFilterEnum = "ALL"
)
func GetDataAssetImportExportTypeFilterEnumValues() []DataAssetImportExportTypeFilterEnum
GetDataAssetImportExportTypeFilterEnumValues Enumerates the set of values for DataAssetImportExportTypeFilterEnum
func GetMappingDataAssetImportExportTypeFilterEnum(val string) (DataAssetImportExportTypeFilterEnum, bool)
GetMappingDataAssetImportExportTypeFilterEnum performs case Insensitive comparison on enum value and return the desired enum
DataAssetPermissionsSummary Permissions object for data assets.
type DataAssetPermissionsSummary struct {
// An array of permissions.
UserPermissions []string `mandatory:"false" json:"userPermissions"`
// The unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
}
func (m DataAssetPermissionsSummary) String() string
func (m DataAssetPermissionsSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAssetSummary Summary of a data asset. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized structure of folders. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.
type DataAssetSummary struct {
// Unique data asset key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the data asset.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// External URI that can be used to reference the object. Format will differ based on the type of object.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// URI to the data asset instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The date and time the data asset was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The key of the object type. Type keys's can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// State of the data asset.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m DataAssetSummary) String() string
func (m DataAssetSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAssetTag Represents an association of a data asset to a term.
type DataAssetTag struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Name of the tag which matches the term name.
Name *string `mandatory:"false" json:"name"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// The current state of the tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// OCID of the user who created the tag.
CreatedById *string `mandatory:"false" json:"createdById"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
}
func (m DataAssetTag) String() string
func (m DataAssetTag) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAssetTagCollection Results of a data asset tag listing. Data asset tags represent an association of a data asset to a term.
type DataAssetTagCollection struct {
// Collection of data asset tags.
Items []DataAssetTagSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m DataAssetTagCollection) String() string
func (m DataAssetTagCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataAssetTagSummary Summary of a data asset tag.
type DataAssetTagSummary struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Name of the tag that matches the term name.
Name *string `mandatory:"false" json:"name"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// Unique id of the parent glossary of the term.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// State of the Tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
}
func (m DataAssetTagSummary) String() string
func (m DataAssetTagSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataCatalogClient a client for DataCatalog
type DataCatalogClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDataCatalogClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataCatalogClient, err error)
NewDataCatalogClientWithConfigurationProvider Creates a new default DataCatalog client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDataCatalogClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataCatalogClient, err error)
NewDataCatalogClientWithOboToken Creates a new default DataCatalog 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 DataCatalogClient) AddCatalogLock(ctx context.Context, request AddCatalogLockRequest) (response AddCatalogLockResponse, err error)
AddCatalogLock Adds a lock to a Catalog resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddCatalogLock.go.html to see an example of how to use AddCatalogLock API.
func (client DataCatalogClient) AddCatalogPrivateEndpointLock(ctx context.Context, request AddCatalogPrivateEndpointLockRequest) (response AddCatalogPrivateEndpointLockResponse, err error)
AddCatalogPrivateEndpointLock Adds a lock to a CatalogPrivateEndpoint resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddCatalogPrivateEndpointLock.go.html to see an example of how to use AddCatalogPrivateEndpointLock API.
func (client DataCatalogClient) AddDataSelectorPatterns(ctx context.Context, request AddDataSelectorPatternsRequest) (response AddDataSelectorPatternsResponse, err error)
AddDataSelectorPatterns Add data selector pattern to the data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddDataSelectorPatterns.go.html to see an example of how to use AddDataSelectorPatterns API.
func (client DataCatalogClient) AddMetastoreLock(ctx context.Context, request AddMetastoreLockRequest) (response AddMetastoreLockResponse, err error)
AddMetastoreLock Adds a lock to a Metastore resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AddMetastoreLock.go.html to see an example of how to use AddMetastoreLock API.
func (client DataCatalogClient) AssociateCustomProperty(ctx context.Context, request AssociateCustomPropertyRequest) (response AssociateCustomPropertyResponse, err error)
AssociateCustomProperty Associate the custom property for the given type
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AssociateCustomProperty.go.html to see an example of how to use AssociateCustomProperty API.
func (client DataCatalogClient) AsynchronousExportDataAsset(ctx context.Context, request AsynchronousExportDataAssetRequest) (response AsynchronousExportDataAssetResponse, err error)
AsynchronousExportDataAsset Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AsynchronousExportDataAsset.go.html to see an example of how to use AsynchronousExportDataAsset API.
func (client DataCatalogClient) AsynchronousExportGlossary(ctx context.Context, request AsynchronousExportGlossaryRequest) (response AsynchronousExportGlossaryResponse, err error)
AsynchronousExportGlossary Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/AsynchronousExportGlossary.go.html to see an example of how to use AsynchronousExportGlossary API.
func (client DataCatalogClient) AttachCatalogPrivateEndpoint(ctx context.Context, request AttachCatalogPrivateEndpointRequest) (response AttachCatalogPrivateEndpointResponse, err error)
AttachCatalogPrivateEndpoint Attaches a private reverse connection endpoint resource to a data catalog resource. 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/datacatalog/AttachCatalogPrivateEndpoint.go.html to see an example of how to use AttachCatalogPrivateEndpoint API.
func (client DataCatalogClient) ChangeCatalogCompartment(ctx context.Context, request ChangeCatalogCompartmentRequest) (response ChangeCatalogCompartmentResponse, err error)
ChangeCatalogCompartment Moves a resource into a different compartment. 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/datacatalog/ChangeCatalogCompartment.go.html to see an example of how to use ChangeCatalogCompartment API.
func (client DataCatalogClient) ChangeCatalogPrivateEndpointCompartment(ctx context.Context, request ChangeCatalogPrivateEndpointCompartmentRequest) (response ChangeCatalogPrivateEndpointCompartmentResponse, err error)
ChangeCatalogPrivateEndpointCompartment Moves a resource into a different compartment. 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/datacatalog/ChangeCatalogPrivateEndpointCompartment.go.html to see an example of how to use ChangeCatalogPrivateEndpointCompartment API.
func (client DataCatalogClient) ChangeMetastoreCompartment(ctx context.Context, request ChangeMetastoreCompartmentRequest) (response ChangeMetastoreCompartmentResponse, err error)
ChangeMetastoreCompartment Moves a resource into a different compartment. 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/datacatalog/ChangeMetastoreCompartment.go.html to see an example of how to use ChangeMetastoreCompartment API.
func (client *DataCatalogClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DataCatalogClient) CreateAttribute(ctx context.Context, request CreateAttributeRequest) (response CreateAttributeResponse, err error)
CreateAttribute Creates a new entity attribute.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateAttribute.go.html to see an example of how to use CreateAttribute API.
func (client DataCatalogClient) CreateAttributeTag(ctx context.Context, request CreateAttributeTagRequest) (response CreateAttributeTagResponse, err error)
CreateAttributeTag Creates a new entity attribute tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateAttributeTag.go.html to see an example of how to use CreateAttributeTag API.
func (client DataCatalogClient) CreateCatalog(ctx context.Context, request CreateCatalogRequest) (response CreateCatalogResponse, err error)
CreateCatalog Creates a new data catalog instance that includes a console and an API URL for managing metadata operations. For more information, please see the documentation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateCatalog.go.html to see an example of how to use CreateCatalog API.
func (client DataCatalogClient) CreateCatalogPrivateEndpoint(ctx context.Context, request CreateCatalogPrivateEndpointRequest) (response CreateCatalogPrivateEndpointResponse, err error)
CreateCatalogPrivateEndpoint Create a new private reverse connection endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateCatalogPrivateEndpoint.go.html to see an example of how to use CreateCatalogPrivateEndpoint API.
func (client DataCatalogClient) 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/datacatalog/CreateConnection.go.html to see an example of how to use CreateConnection API.
func (client DataCatalogClient) CreateCustomProperty(ctx context.Context, request CreateCustomPropertyRequest) (response CreateCustomPropertyResponse, err error)
CreateCustomProperty Create a new Custom Property
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateCustomProperty.go.html to see an example of how to use CreateCustomProperty API.
func (client DataCatalogClient) CreateDataAsset(ctx context.Context, request CreateDataAssetRequest) (response CreateDataAssetResponse, err error)
CreateDataAsset Create a new data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateDataAsset.go.html to see an example of how to use CreateDataAsset API.
func (client DataCatalogClient) CreateDataAssetTag(ctx context.Context, request CreateDataAssetTagRequest) (response CreateDataAssetTagResponse, err error)
CreateDataAssetTag Creates a new data asset tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateDataAssetTag.go.html to see an example of how to use CreateDataAssetTag API.
func (client DataCatalogClient) CreateEntity(ctx context.Context, request CreateEntityRequest) (response CreateEntityResponse, err error)
CreateEntity Creates a new data entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateEntity.go.html to see an example of how to use CreateEntity API.
func (client DataCatalogClient) CreateEntityTag(ctx context.Context, request CreateEntityTagRequest) (response CreateEntityTagResponse, err error)
CreateEntityTag Creates a new entity tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateEntityTag.go.html to see an example of how to use CreateEntityTag API.
func (client DataCatalogClient) CreateFolder(ctx context.Context, request CreateFolderRequest) (response CreateFolderResponse, err error)
CreateFolder Creates a new folder.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateFolder.go.html to see an example of how to use CreateFolder API.
func (client DataCatalogClient) CreateFolderTag(ctx context.Context, request CreateFolderTagRequest) (response CreateFolderTagResponse, err error)
CreateFolderTag Creates a new folder tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateFolderTag.go.html to see an example of how to use CreateFolderTag API.
func (client DataCatalogClient) CreateGlossary(ctx context.Context, request CreateGlossaryRequest) (response CreateGlossaryResponse, err error)
CreateGlossary Creates a new glossary.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateGlossary.go.html to see an example of how to use CreateGlossary API.
func (client DataCatalogClient) CreateJob(ctx context.Context, request CreateJobRequest) (response CreateJobResponse, err error)
CreateJob Creates a new job.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateJob.go.html to see an example of how to use CreateJob API.
func (client DataCatalogClient) CreateJobDefinition(ctx context.Context, request CreateJobDefinitionRequest) (response CreateJobDefinitionResponse, err error)
CreateJobDefinition Creates a new job definition.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateJobDefinition.go.html to see an example of how to use CreateJobDefinition API.
func (client DataCatalogClient) CreateJobExecution(ctx context.Context, request CreateJobExecutionRequest) (response CreateJobExecutionResponse, err error)
CreateJobExecution Creates a new job execution.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateJobExecution.go.html to see an example of how to use CreateJobExecution API.
func (client DataCatalogClient) CreateMetastore(ctx context.Context, request CreateMetastoreRequest) (response CreateMetastoreResponse, err error)
CreateMetastore Creates a new metastore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateMetastore.go.html to see an example of how to use CreateMetastore API.
func (client DataCatalogClient) CreateNamespace(ctx context.Context, request CreateNamespaceRequest) (response CreateNamespaceResponse, err error)
CreateNamespace Create a new Namespace to be used by a custom property
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateNamespace.go.html to see an example of how to use CreateNamespace API.
func (client DataCatalogClient) CreatePattern(ctx context.Context, request CreatePatternRequest) (response CreatePatternResponse, err error)
CreatePattern Create a new pattern.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreatePattern.go.html to see an example of how to use CreatePattern API.
func (client DataCatalogClient) CreateTerm(ctx context.Context, request CreateTermRequest) (response CreateTermResponse, err error)
CreateTerm Create a new term within a glossary.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateTerm.go.html to see an example of how to use CreateTerm API.
func (client DataCatalogClient) CreateTermRelationship(ctx context.Context, request CreateTermRelationshipRequest) (response CreateTermRelationshipResponse, err error)
CreateTermRelationship Creates a new term relationship for this term within a glossary.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/CreateTermRelationship.go.html to see an example of how to use CreateTermRelationship API.
func (client DataCatalogClient) DeleteAttribute(ctx context.Context, request DeleteAttributeRequest) (response DeleteAttributeResponse, err error)
DeleteAttribute Deletes a specific entity attribute.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteAttribute.go.html to see an example of how to use DeleteAttribute API.
func (client DataCatalogClient) DeleteAttributeTag(ctx context.Context, request DeleteAttributeTagRequest) (response DeleteAttributeTagResponse, err error)
DeleteAttributeTag Deletes a specific entity attribute tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteAttributeTag.go.html to see an example of how to use DeleteAttributeTag API.
func (client DataCatalogClient) DeleteCatalog(ctx context.Context, request DeleteCatalogRequest) (response DeleteCatalogResponse, err error)
DeleteCatalog Deletes a data catalog resource by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteCatalog.go.html to see an example of how to use DeleteCatalog API.
func (client DataCatalogClient) DeleteCatalogPrivateEndpoint(ctx context.Context, request DeleteCatalogPrivateEndpointRequest) (response DeleteCatalogPrivateEndpointResponse, err error)
DeleteCatalogPrivateEndpoint Deletes a private reverse connection endpoint by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteCatalogPrivateEndpoint.go.html to see an example of how to use DeleteCatalogPrivateEndpoint API.
func (client DataCatalogClient) DeleteConnection(ctx context.Context, request DeleteConnectionRequest) (response DeleteConnectionResponse, err error)
DeleteConnection Deletes a specific connection of a data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteConnection.go.html to see an example of how to use DeleteConnection API.
func (client DataCatalogClient) DeleteCustomProperty(ctx context.Context, request DeleteCustomPropertyRequest) (response DeleteCustomPropertyResponse, err error)
DeleteCustomProperty Deletes a specific custom property identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteCustomProperty.go.html to see an example of how to use DeleteCustomProperty API.
func (client DataCatalogClient) DeleteDataAsset(ctx context.Context, request DeleteDataAssetRequest) (response DeleteDataAssetResponse, err error)
DeleteDataAsset Deletes a specific data asset identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteDataAsset.go.html to see an example of how to use DeleteDataAsset API.
func (client DataCatalogClient) DeleteDataAssetTag(ctx context.Context, request DeleteDataAssetTagRequest) (response DeleteDataAssetTagResponse, err error)
DeleteDataAssetTag Deletes a specific data asset tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteDataAssetTag.go.html to see an example of how to use DeleteDataAssetTag API.
func (client DataCatalogClient) DeleteEntity(ctx context.Context, request DeleteEntityRequest) (response DeleteEntityResponse, err error)
DeleteEntity Deletes a specific data entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteEntity.go.html to see an example of how to use DeleteEntity API.
func (client DataCatalogClient) DeleteEntityTag(ctx context.Context, request DeleteEntityTagRequest) (response DeleteEntityTagResponse, err error)
DeleteEntityTag Deletes a specific entity tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteEntityTag.go.html to see an example of how to use DeleteEntityTag API.
func (client DataCatalogClient) DeleteFolder(ctx context.Context, request DeleteFolderRequest) (response DeleteFolderResponse, err error)
DeleteFolder Deletes a specific folder of a data asset identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteFolder.go.html to see an example of how to use DeleteFolder API.
func (client DataCatalogClient) DeleteFolderTag(ctx context.Context, request DeleteFolderTagRequest) (response DeleteFolderTagResponse, err error)
DeleteFolderTag Deletes a specific folder tag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteFolderTag.go.html to see an example of how to use DeleteFolderTag API.
func (client DataCatalogClient) DeleteGlossary(ctx context.Context, request DeleteGlossaryRequest) (response DeleteGlossaryResponse, err error)
DeleteGlossary Deletes a specific glossary identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteGlossary.go.html to see an example of how to use DeleteGlossary API.
func (client DataCatalogClient) DeleteJob(ctx context.Context, request DeleteJobRequest) (response DeleteJobResponse, err error)
DeleteJob Deletes a specific job identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteJob.go.html to see an example of how to use DeleteJob API.
func (client DataCatalogClient) DeleteJobDefinition(ctx context.Context, request DeleteJobDefinitionRequest) (response DeleteJobDefinitionResponse, err error)
DeleteJobDefinition Deletes a specific job definition identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteJobDefinition.go.html to see an example of how to use DeleteJobDefinition API.
func (client DataCatalogClient) DeleteMetastore(ctx context.Context, request DeleteMetastoreRequest) (response DeleteMetastoreResponse, err error)
DeleteMetastore Deletes a metastore resource by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteMetastore.go.html to see an example of how to use DeleteMetastore API.
func (client DataCatalogClient) DeleteNamespace(ctx context.Context, request DeleteNamespaceRequest) (response DeleteNamespaceResponse, err error)
DeleteNamespace Deletes a specific Namespace identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteNamespace.go.html to see an example of how to use DeleteNamespace API.
func (client DataCatalogClient) DeletePattern(ctx context.Context, request DeletePatternRequest) (response DeletePatternResponse, err error)
DeletePattern Deletes a specific pattern identified by it's key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeletePattern.go.html to see an example of how to use DeletePattern API.
func (client DataCatalogClient) DeleteTerm(ctx context.Context, request DeleteTermRequest) (response DeleteTermResponse, err error)
DeleteTerm Deletes a specific glossary term.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteTerm.go.html to see an example of how to use DeleteTerm API.
func (client DataCatalogClient) DeleteTermRelationship(ctx context.Context, request DeleteTermRelationshipRequest) (response DeleteTermRelationshipResponse, err error)
DeleteTermRelationship Deletes a specific glossary term relationship.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteTermRelationship.go.html to see an example of how to use DeleteTermRelationship API.
func (client DataCatalogClient) DetachCatalogPrivateEndpoint(ctx context.Context, request DetachCatalogPrivateEndpointRequest) (response DetachCatalogPrivateEndpointResponse, err error)
DetachCatalogPrivateEndpoint Detaches a private reverse connection endpoint resource to a data catalog resource. 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/datacatalog/DetachCatalogPrivateEndpoint.go.html to see an example of how to use DetachCatalogPrivateEndpoint API.
func (client DataCatalogClient) DisassociateCustomProperty(ctx context.Context, request DisassociateCustomPropertyRequest) (response DisassociateCustomPropertyResponse, err error)
DisassociateCustomProperty Remove the custom property for the given type
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DisassociateCustomProperty.go.html to see an example of how to use DisassociateCustomProperty API.
func (client DataCatalogClient) ExpandTreeForGlossary(ctx context.Context, request ExpandTreeForGlossaryRequest) (response ExpandTreeForGlossaryResponse, err error)
ExpandTreeForGlossary Returns the fully expanded tree hierarchy of parent and child terms in this glossary.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ExpandTreeForGlossary.go.html to see an example of how to use ExpandTreeForGlossary API. A default retry strategy applies to this operation ExpandTreeForGlossary()
func (client DataCatalogClient) ExportGlossary(ctx context.Context, request ExportGlossaryRequest) (response ExportGlossaryResponse, err error)
ExportGlossary Export the glossary and the terms and return the exported glossary as csv or json.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ExportGlossary.go.html to see an example of how to use ExportGlossary API.
func (client DataCatalogClient) FetchEntityLineage(ctx context.Context, request FetchEntityLineageRequest) (response FetchEntityLineageResponse, err error)
FetchEntityLineage Returns lineage for a given entity object.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/FetchEntityLineage.go.html to see an example of how to use FetchEntityLineage API. A default retry strategy applies to this operation FetchEntityLineage()
func (client DataCatalogClient) GetAttribute(ctx context.Context, request GetAttributeRequest) (response GetAttributeResponse, err error)
GetAttribute Gets a specific entity attribute by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetAttribute.go.html to see an example of how to use GetAttribute API. A default retry strategy applies to this operation GetAttribute()
func (client DataCatalogClient) GetAttributeTag(ctx context.Context, request GetAttributeTagRequest) (response GetAttributeTagResponse, err error)
GetAttributeTag Gets a specific entity attribute tag by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetAttributeTag.go.html to see an example of how to use GetAttributeTag API. A default retry strategy applies to this operation GetAttributeTag()
func (client DataCatalogClient) GetCatalog(ctx context.Context, request GetCatalogRequest) (response GetCatalogResponse, err error)
GetCatalog Gets a data catalog by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetCatalog.go.html to see an example of how to use GetCatalog API. A default retry strategy applies to this operation GetCatalog()
func (client DataCatalogClient) GetCatalogPrivateEndpoint(ctx context.Context, request GetCatalogPrivateEndpointRequest) (response GetCatalogPrivateEndpointResponse, err error)
GetCatalogPrivateEndpoint Gets a specific private reverse connection by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetCatalogPrivateEndpoint.go.html to see an example of how to use GetCatalogPrivateEndpoint API. A default retry strategy applies to this operation GetCatalogPrivateEndpoint()
func (client DataCatalogClient) GetConnection(ctx context.Context, request GetConnectionRequest) (response GetConnectionResponse, err error)
GetConnection Gets a specific data asset connection by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetConnection.go.html to see an example of how to use GetConnection API. A default retry strategy applies to this operation GetConnection()
func (client DataCatalogClient) GetCustomProperty(ctx context.Context, request GetCustomPropertyRequest) (response GetCustomPropertyResponse, err error)
GetCustomProperty Gets a specific custom property for the given key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetCustomProperty.go.html to see an example of how to use GetCustomProperty API. A default retry strategy applies to this operation GetCustomProperty()
func (client DataCatalogClient) GetDataAsset(ctx context.Context, request GetDataAssetRequest) (response GetDataAssetResponse, err error)
GetDataAsset Gets a specific data asset for the given key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetDataAsset.go.html to see an example of how to use GetDataAsset API. A default retry strategy applies to this operation GetDataAsset()
func (client DataCatalogClient) GetDataAssetTag(ctx context.Context, request GetDataAssetTagRequest) (response GetDataAssetTagResponse, err error)
GetDataAssetTag Gets a specific data asset tag by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetDataAssetTag.go.html to see an example of how to use GetDataAssetTag API. A default retry strategy applies to this operation GetDataAssetTag()
func (client DataCatalogClient) GetEntity(ctx context.Context, request GetEntityRequest) (response GetEntityResponse, err error)
GetEntity Gets a specific data entity by key for a data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetEntity.go.html to see an example of how to use GetEntity API. A default retry strategy applies to this operation GetEntity()
func (client DataCatalogClient) GetEntityTag(ctx context.Context, request GetEntityTagRequest) (response GetEntityTagResponse, err error)
GetEntityTag Gets a specific entity tag by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetEntityTag.go.html to see an example of how to use GetEntityTag API. A default retry strategy applies to this operation GetEntityTag()
func (client DataCatalogClient) GetFolder(ctx context.Context, request GetFolderRequest) (response GetFolderResponse, err error)
GetFolder Gets a specific data asset folder by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetFolder.go.html to see an example of how to use GetFolder API. A default retry strategy applies to this operation GetFolder()
func (client DataCatalogClient) GetFolderTag(ctx context.Context, request GetFolderTagRequest) (response GetFolderTagResponse, err error)
GetFolderTag Gets a specific folder tag by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetFolderTag.go.html to see an example of how to use GetFolderTag API. A default retry strategy applies to this operation GetFolderTag()
func (client DataCatalogClient) GetGlossary(ctx context.Context, request GetGlossaryRequest) (response GetGlossaryResponse, err error)
GetGlossary Gets a specific glossary by key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetGlossary.go.html to see an example of how to use GetGlossary API. A default retry strategy applies to this operation GetGlossary()
func (client DataCatalogClient) GetJob(ctx context.Context, request GetJobRequest) (response GetJobResponse, err error)
GetJob Gets a specific job by key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJob.go.html to see an example of how to use GetJob API. A default retry strategy applies to this operation GetJob()
func (client DataCatalogClient) GetJobDefinition(ctx context.Context, request GetJobDefinitionRequest) (response GetJobDefinitionResponse, err error)
GetJobDefinition Gets a specific job definition by key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobDefinition.go.html to see an example of how to use GetJobDefinition API. A default retry strategy applies to this operation GetJobDefinition()
func (client DataCatalogClient) GetJobExecution(ctx context.Context, request GetJobExecutionRequest) (response GetJobExecutionResponse, err error)
GetJobExecution Gets a specific job execution by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobExecution.go.html to see an example of how to use GetJobExecution API. A default retry strategy applies to this operation GetJobExecution()
func (client DataCatalogClient) GetJobLog(ctx context.Context, request GetJobLogRequest) (response GetJobLogResponse, err error)
GetJobLog Gets a specific job log by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobLog.go.html to see an example of how to use GetJobLog API. A default retry strategy applies to this operation GetJobLog()
func (client DataCatalogClient) GetJobMetrics(ctx context.Context, request GetJobMetricsRequest) (response GetJobMetricsResponse, err error)
GetJobMetrics Gets a specific job metric by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobMetrics.go.html to see an example of how to use GetJobMetrics API. A default retry strategy applies to this operation GetJobMetrics()
func (client DataCatalogClient) GetMetastore(ctx context.Context, request GetMetastoreRequest) (response GetMetastoreResponse, err error)
GetMetastore Gets a metastore by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetMetastore.go.html to see an example of how to use GetMetastore API. A default retry strategy applies to this operation GetMetastore()
func (client DataCatalogClient) GetNamespace(ctx context.Context, request GetNamespaceRequest) (response GetNamespaceResponse, err error)
GetNamespace Gets a specific namespace for the given key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetNamespace.go.html to see an example of how to use GetNamespace API. A default retry strategy applies to this operation GetNamespace()
func (client DataCatalogClient) GetPattern(ctx context.Context, request GetPatternRequest) (response GetPatternResponse, err error)
GetPattern Gets a specific pattern for the given key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetPattern.go.html to see an example of how to use GetPattern API. A default retry strategy applies to this operation GetPattern()
func (client DataCatalogClient) GetTerm(ctx context.Context, request GetTermRequest) (response GetTermResponse, err error)
GetTerm Gets a specific glossary term by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetTerm.go.html to see an example of how to use GetTerm API. A default retry strategy applies to this operation GetTerm()
func (client DataCatalogClient) GetTermRelationship(ctx context.Context, request GetTermRelationshipRequest) (response GetTermRelationshipResponse, err error)
GetTermRelationship Gets a specific glossary term relationship by key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetTermRelationship.go.html to see an example of how to use GetTermRelationship API. A default retry strategy applies to this operation GetTermRelationship()
func (client DataCatalogClient) GetType(ctx context.Context, request GetTypeRequest) (response GetTypeResponse, err error)
GetType Gets a specific type by key within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetType.go.html to see an example of how to use GetType API. A default retry strategy applies to this operation GetType()
func (client DataCatalogClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client DataCatalogClient) ImportConnection(ctx context.Context, request ImportConnectionRequest) (response ImportConnectionResponse, err error)
ImportConnection Import new connection for this data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportConnection.go.html to see an example of how to use ImportConnection API.
func (client DataCatalogClient) ImportDataAsset(ctx context.Context, request ImportDataAssetRequest) (response ImportDataAssetResponse, err error)
ImportDataAsset Import technical objects to a Data Asset
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportDataAsset.go.html to see an example of how to use ImportDataAsset API.
func (client DataCatalogClient) ImportGlossary(ctx context.Context, request ImportGlossaryRequest) (response ImportGlossaryResponse, err error)
ImportGlossary Import the glossary and the terms from csv or json files and return the imported glossary resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportGlossary.go.html to see an example of how to use ImportGlossary API.
func (client DataCatalogClient) ImportLineage(ctx context.Context, request ImportLineageRequest) (response ImportLineageResponse, err error)
ImportLineage Imports lineage metadata. Returns details about the job that performs the import.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportLineage.go.html to see an example of how to use ImportLineage API. A default retry strategy applies to this operation ImportLineage()
func (client DataCatalogClient) ListAggregatedPhysicalEntities(ctx context.Context, request ListAggregatedPhysicalEntitiesRequest) (response ListAggregatedPhysicalEntitiesResponse, err error)
ListAggregatedPhysicalEntities List the physical entities aggregated by this logical entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAggregatedPhysicalEntities.go.html to see an example of how to use ListAggregatedPhysicalEntities API. A default retry strategy applies to this operation ListAggregatedPhysicalEntities()
func (client DataCatalogClient) ListAttributeTags(ctx context.Context, request ListAttributeTagsRequest) (response ListAttributeTagsResponse, err error)
ListAttributeTags Returns a list of all tags for an entity attribute.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAttributeTags.go.html to see an example of how to use ListAttributeTags API. A default retry strategy applies to this operation ListAttributeTags()
func (client DataCatalogClient) ListAttributes(ctx context.Context, request ListAttributesRequest) (response ListAttributesResponse, err error)
ListAttributes Returns a list of all attributes of an data entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAttributes.go.html to see an example of how to use ListAttributes API. A default retry strategy applies to this operation ListAttributes()
func (client DataCatalogClient) ListCatalogPrivateEndpoints(ctx context.Context, request ListCatalogPrivateEndpointsRequest) (response ListCatalogPrivateEndpointsResponse, err error)
ListCatalogPrivateEndpoints Returns a list of all the catalog private endpoints in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListCatalogPrivateEndpoints.go.html to see an example of how to use ListCatalogPrivateEndpoints API. A default retry strategy applies to this operation ListCatalogPrivateEndpoints()
func (client DataCatalogClient) ListCatalogs(ctx context.Context, request ListCatalogsRequest) (response ListCatalogsResponse, err error)
ListCatalogs Returns a list of all the data catalogs in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListCatalogs.go.html to see an example of how to use ListCatalogs API. A default retry strategy applies to this operation ListCatalogs()
func (client DataCatalogClient) ListConnections(ctx context.Context, request ListConnectionsRequest) (response ListConnectionsResponse, err error)
ListConnections Returns a list of all Connections for a data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListConnections.go.html to see an example of how to use ListConnections API. A default retry strategy applies to this operation ListConnections()
func (client DataCatalogClient) ListCustomProperties(ctx context.Context, request ListCustomPropertiesRequest) (response ListCustomPropertiesResponse, err error)
ListCustomProperties Returns a list of custom properties within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListCustomProperties.go.html to see an example of how to use ListCustomProperties API. A default retry strategy applies to this operation ListCustomProperties()
func (client DataCatalogClient) ListDataAssetTags(ctx context.Context, request ListDataAssetTagsRequest) (response ListDataAssetTagsResponse, err error)
ListDataAssetTags Returns a list of all tags for a data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListDataAssetTags.go.html to see an example of how to use ListDataAssetTags API. A default retry strategy applies to this operation ListDataAssetTags()
func (client DataCatalogClient) ListDataAssets(ctx context.Context, request ListDataAssetsRequest) (response ListDataAssetsResponse, err error)
ListDataAssets Returns a list of data assets within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListDataAssets.go.html to see an example of how to use ListDataAssets API. A default retry strategy applies to this operation ListDataAssets()
func (client DataCatalogClient) ListDerivedLogicalEntities(ctx context.Context, request ListDerivedLogicalEntitiesRequest) (response ListDerivedLogicalEntitiesResponse, err error)
ListDerivedLogicalEntities List logical entities derived from this pattern.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListDerivedLogicalEntities.go.html to see an example of how to use ListDerivedLogicalEntities API. A default retry strategy applies to this operation ListDerivedLogicalEntities()
func (client DataCatalogClient) ListEntities(ctx context.Context, request ListEntitiesRequest) (response ListEntitiesResponse, err error)
ListEntities Returns a list of all entities of a data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListEntities.go.html to see an example of how to use ListEntities API. A default retry strategy applies to this operation ListEntities()
func (client DataCatalogClient) ListEntityTags(ctx context.Context, request ListEntityTagsRequest) (response ListEntityTagsResponse, err error)
ListEntityTags Returns a list of all tags for a data entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListEntityTags.go.html to see an example of how to use ListEntityTags API. A default retry strategy applies to this operation ListEntityTags()
func (client DataCatalogClient) ListFolderTags(ctx context.Context, request ListFolderTagsRequest) (response ListFolderTagsResponse, err error)
ListFolderTags Returns a list of all tags for a folder.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListFolderTags.go.html to see an example of how to use ListFolderTags API. A default retry strategy applies to this operation ListFolderTags()
func (client DataCatalogClient) ListFolders(ctx context.Context, request ListFoldersRequest) (response ListFoldersResponse, err error)
ListFolders Returns a list of all folders.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListFolders.go.html to see an example of how to use ListFolders API. A default retry strategy applies to this operation ListFolders()
func (client DataCatalogClient) ListGlossaries(ctx context.Context, request ListGlossariesRequest) (response ListGlossariesResponse, err error)
ListGlossaries Returns a list of all glossaries within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListGlossaries.go.html to see an example of how to use ListGlossaries API. A default retry strategy applies to this operation ListGlossaries()
func (client DataCatalogClient) ListJobDefinitions(ctx context.Context, request ListJobDefinitionsRequest) (response ListJobDefinitionsResponse, err error)
ListJobDefinitions Returns a list of job definitions within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobDefinitions.go.html to see an example of how to use ListJobDefinitions API. A default retry strategy applies to this operation ListJobDefinitions()
func (client DataCatalogClient) ListJobExecutions(ctx context.Context, request ListJobExecutionsRequest) (response ListJobExecutionsResponse, err error)
ListJobExecutions Returns a list of job executions for a job.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobExecutions.go.html to see an example of how to use ListJobExecutions API. A default retry strategy applies to this operation ListJobExecutions()
func (client DataCatalogClient) ListJobLogs(ctx context.Context, request ListJobLogsRequest) (response ListJobLogsResponse, err error)
ListJobLogs Returns a list of job logs.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobLogs.go.html to see an example of how to use ListJobLogs API. A default retry strategy applies to this operation ListJobLogs()
func (client DataCatalogClient) ListJobMetrics(ctx context.Context, request ListJobMetricsRequest) (response ListJobMetricsResponse, err error)
ListJobMetrics Returns a list of job metrics.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobMetrics.go.html to see an example of how to use ListJobMetrics API. A default retry strategy applies to this operation ListJobMetrics()
func (client DataCatalogClient) ListJobs(ctx context.Context, request ListJobsRequest) (response ListJobsResponse, err error)
ListJobs Returns a list of jobs within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobs.go.html to see an example of how to use ListJobs API. A default retry strategy applies to this operation ListJobs()
func (client DataCatalogClient) ListMetastores(ctx context.Context, request ListMetastoresRequest) (response ListMetastoresResponse, err error)
ListMetastores Returns a list of all metastores in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListMetastores.go.html to see an example of how to use ListMetastores API. A default retry strategy applies to this operation ListMetastores()
func (client DataCatalogClient) ListNamespaces(ctx context.Context, request ListNamespacesRequest) (response ListNamespacesResponse, err error)
ListNamespaces Returns a list of namespaces within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListNamespaces.go.html to see an example of how to use ListNamespaces API. A default retry strategy applies to this operation ListNamespaces()
func (client DataCatalogClient) ListPatterns(ctx context.Context, request ListPatternsRequest) (response ListPatternsResponse, err error)
ListPatterns Returns a list of patterns within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListPatterns.go.html to see an example of how to use ListPatterns API. A default retry strategy applies to this operation ListPatterns()
func (client DataCatalogClient) ListRules(ctx context.Context, request ListRulesRequest) (response ListRulesResponse, err error)
ListRules Returns a list of all rules of a data entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListRules.go.html to see an example of how to use ListRules API. A default retry strategy applies to this operation ListRules()
func (client DataCatalogClient) ListTags(ctx context.Context, request ListTagsRequest) (response ListTagsResponse, err error)
ListTags Returns a list of all user created tags in the system.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTags.go.html to see an example of how to use ListTags API. A default retry strategy applies to this operation ListTags()
func (client DataCatalogClient) ListTermRelationships(ctx context.Context, request ListTermRelationshipsRequest) (response ListTermRelationshipsResponse, err error)
ListTermRelationships Returns a list of all term relationships within a glossary.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTermRelationships.go.html to see an example of how to use ListTermRelationships API. A default retry strategy applies to this operation ListTermRelationships()
func (client DataCatalogClient) ListTerms(ctx context.Context, request ListTermsRequest) (response ListTermsResponse, err error)
ListTerms Returns a list of all terms within a glossary.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTerms.go.html to see an example of how to use ListTerms API. A default retry strategy applies to this operation ListTerms()
func (client DataCatalogClient) ListTypes(ctx context.Context, request ListTypesRequest) (response ListTypesResponse, err error)
ListTypes Returns a list of all types within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTypes.go.html to see an example of how to use ListTypes API. A default retry strategy applies to this operation ListTypes()
func (client DataCatalogClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client DataCatalogClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client DataCatalogClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client DataCatalogClient) ObjectStats(ctx context.Context, request ObjectStatsRequest) (response ObjectStatsResponse, err error)
ObjectStats Returns stats on objects by type in the repository.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ObjectStats.go.html to see an example of how to use ObjectStats API. A default retry strategy applies to this operation ObjectStats()
func (client DataCatalogClient) ParseConnection(ctx context.Context, request ParseConnectionRequest) (response ParseConnectionResponse, err error)
ParseConnection Parse data asset references through connections from this data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ParseConnection.go.html to see an example of how to use ParseConnection API.
func (client DataCatalogClient) ProcessRecommendation(ctx context.Context, request ProcessRecommendationRequest) (response ProcessRecommendationResponse, err error)
ProcessRecommendation Act on a recommendation. A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM is accepted, the system will link the source object (e.g. an attribute) to a target glossary term.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ProcessRecommendation.go.html to see an example of how to use ProcessRecommendation API.
func (client DataCatalogClient) Recommendations(ctx context.Context, request RecommendationsRequest) (response RecommendationsResponse, err error)
Recommendations Returns a list of recommendations for the given object and recommendation type. By default, it will return inferred recommendations for review. The optional query param 'RecommendationStatus' can be set, to return only recommendations having that status.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/Recommendations.go.html to see an example of how to use Recommendations API.
func (client DataCatalogClient) RemoveCatalogLock(ctx context.Context, request RemoveCatalogLockRequest) (response RemoveCatalogLockResponse, err error)
RemoveCatalogLock Removes a lock from a Catalog resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveCatalogLock.go.html to see an example of how to use RemoveCatalogLock API.
func (client DataCatalogClient) RemoveCatalogPrivateEndpointLock(ctx context.Context, request RemoveCatalogPrivateEndpointLockRequest) (response RemoveCatalogPrivateEndpointLockResponse, err error)
RemoveCatalogPrivateEndpointLock Removes a lock from a CatalogPrivateEndpoint resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveCatalogPrivateEndpointLock.go.html to see an example of how to use RemoveCatalogPrivateEndpointLock API.
func (client DataCatalogClient) RemoveDataSelectorPatterns(ctx context.Context, request RemoveDataSelectorPatternsRequest) (response RemoveDataSelectorPatternsResponse, err error)
RemoveDataSelectorPatterns Remove data selector pattern from the data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveDataSelectorPatterns.go.html to see an example of how to use RemoveDataSelectorPatterns API.
func (client DataCatalogClient) RemoveMetastoreLock(ctx context.Context, request RemoveMetastoreLockRequest) (response RemoveMetastoreLockResponse, err error)
RemoveMetastoreLock Removes a lock from a Metastore resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveMetastoreLock.go.html to see an example of how to use RemoveMetastoreLock API.
func (client DataCatalogClient) SearchCriteria(ctx context.Context, request SearchCriteriaRequest) (response SearchCriteriaResponse, err error)
SearchCriteria Returns a list of search results within a data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/SearchCriteria.go.html to see an example of how to use SearchCriteria API. A default retry strategy applies to this operation SearchCriteria()
func (client *DataCatalogClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DataCatalogClient) SuggestMatches(ctx context.Context, request SuggestMatchesRequest) (response SuggestMatchesResponse, err error)
SuggestMatches Returns a list of potential string matches for a given input string.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/SuggestMatches.go.html to see an example of how to use SuggestMatches API. A default retry strategy applies to this operation SuggestMatches()
func (client DataCatalogClient) SynchronousExportDataAsset(ctx context.Context, request SynchronousExportDataAssetRequest) (response SynchronousExportDataAssetResponse, err error)
SynchronousExportDataAsset Export technical objects from a Data Asset
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/SynchronousExportDataAsset.go.html to see an example of how to use SynchronousExportDataAsset API.
func (client DataCatalogClient) TestConnection(ctx context.Context, request TestConnectionRequest) (response TestConnectionResponse, err error)
TestConnection Test the connection by connecting to the data asset using credentials in the metadata.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/TestConnection.go.html to see an example of how to use TestConnection API. A default retry strategy applies to this operation TestConnection()
func (client DataCatalogClient) UpdateAttribute(ctx context.Context, request UpdateAttributeRequest) (response UpdateAttributeResponse, err error)
UpdateAttribute Updates a specific data asset attribute.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateAttribute.go.html to see an example of how to use UpdateAttribute API.
func (client DataCatalogClient) UpdateCatalog(ctx context.Context, request UpdateCatalogRequest) (response UpdateCatalogResponse, err error)
UpdateCatalog Updates the data catalog.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateCatalog.go.html to see an example of how to use UpdateCatalog API.
func (client DataCatalogClient) UpdateCatalogPrivateEndpoint(ctx context.Context, request UpdateCatalogPrivateEndpointRequest) (response UpdateCatalogPrivateEndpointResponse, err error)
UpdateCatalogPrivateEndpoint Updates the private reverse connection endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateCatalogPrivateEndpoint.go.html to see an example of how to use UpdateCatalogPrivateEndpoint API.
func (client DataCatalogClient) UpdateConnection(ctx context.Context, request UpdateConnectionRequest) (response UpdateConnectionResponse, err error)
UpdateConnection Updates a specific connection of a data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateConnection.go.html to see an example of how to use UpdateConnection API.
func (client DataCatalogClient) UpdateCustomProperty(ctx context.Context, request UpdateCustomPropertyRequest) (response UpdateCustomPropertyResponse, err error)
UpdateCustomProperty Updates a specific custom property identified by the given key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateCustomProperty.go.html to see an example of how to use UpdateCustomProperty API.
func (client DataCatalogClient) UpdateDataAsset(ctx context.Context, request UpdateDataAssetRequest) (response UpdateDataAssetResponse, err error)
UpdateDataAsset Updates a specific data asset identified by the given key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateDataAsset.go.html to see an example of how to use UpdateDataAsset API.
func (client DataCatalogClient) UpdateEntity(ctx context.Context, request UpdateEntityRequest) (response UpdateEntityResponse, err error)
UpdateEntity Updates a specific data entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateEntity.go.html to see an example of how to use UpdateEntity API.
func (client DataCatalogClient) UpdateFolder(ctx context.Context, request UpdateFolderRequest) (response UpdateFolderResponse, err error)
UpdateFolder Updates a specific folder of a data asset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateFolder.go.html to see an example of how to use UpdateFolder API.
func (client DataCatalogClient) UpdateGlossary(ctx context.Context, request UpdateGlossaryRequest) (response UpdateGlossaryResponse, err error)
UpdateGlossary Updates a specific glossary identified by the given key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateGlossary.go.html to see an example of how to use UpdateGlossary API.
func (client DataCatalogClient) UpdateJob(ctx context.Context, request UpdateJobRequest) (response UpdateJobResponse, err error)
UpdateJob Updates a specific job identified by the given key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateJob.go.html to see an example of how to use UpdateJob API.
func (client DataCatalogClient) UpdateJobDefinition(ctx context.Context, request UpdateJobDefinitionRequest) (response UpdateJobDefinitionResponse, err error)
UpdateJobDefinition Update a specific job definition identified by the given key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateJobDefinition.go.html to see an example of how to use UpdateJobDefinition API.
func (client DataCatalogClient) UpdateMetastore(ctx context.Context, request UpdateMetastoreRequest) (response UpdateMetastoreResponse, err error)
UpdateMetastore Updates a metastore resource by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateMetastore.go.html to see an example of how to use UpdateMetastore API.
func (client DataCatalogClient) UpdateNamespace(ctx context.Context, request UpdateNamespaceRequest) (response UpdateNamespaceResponse, err error)
UpdateNamespace Updates a specific namespace identified by the given key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateNamespace.go.html to see an example of how to use UpdateNamespace API.
func (client DataCatalogClient) UpdatePattern(ctx context.Context, request UpdatePatternRequest) (response UpdatePatternResponse, err error)
UpdatePattern Updates a specific pattern identified by the given key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdatePattern.go.html to see an example of how to use UpdatePattern API.
func (client DataCatalogClient) UpdateTerm(ctx context.Context, request UpdateTermRequest) (response UpdateTermResponse, err error)
UpdateTerm Updates a specific glossary term.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateTerm.go.html to see an example of how to use UpdateTerm API.
func (client DataCatalogClient) UpdateTermRelationship(ctx context.Context, request UpdateTermRelationshipRequest) (response UpdateTermRelationshipResponse, err error)
UpdateTermRelationship Updates a specific glossary term relationship.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateTermRelationship.go.html to see an example of how to use UpdateTermRelationship API.
func (client DataCatalogClient) UploadCredentials(ctx context.Context, request UploadCredentialsRequest) (response UploadCredentialsResponse, err error)
UploadCredentials Upload connection credentails and metadata for this connection.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UploadCredentials.go.html to see an example of how to use UploadCredentials API.
func (client DataCatalogClient) Users(ctx context.Context, request UsersRequest) (response UsersResponse, err error)
Users Returns active users in the system.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/Users.go.html to see an example of how to use Users API. A default retry strategy applies to this operation Users()
func (client DataCatalogClient) ValidateConnection(ctx context.Context, request ValidateConnectionRequest) (response ValidateConnectionResponse, err error)
ValidateConnection Validate connection by connecting to the data asset using credentials in metadata.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ValidateConnection.go.html to see an example of how to use ValidateConnection API. A default retry strategy applies to this operation ValidateConnection()
func (client DataCatalogClient) ValidatePattern(ctx context.Context, request ValidatePatternRequest) (response ValidatePatternResponse, err error)
ValidatePattern Validate pattern by deriving file groups representing logical entities using the expression
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ValidatePattern.go.html to see an example of how to use ValidatePattern API. A default retry strategy applies to this operation ValidatePattern()
DataSelectorPatternDetails List of pattern Ids. Used in the addition and removal of patterns in data assets.
type DataSelectorPatternDetails struct {
// Collection of pattern Ids.
Items []string `mandatory:"true" json:"items"`
}
func (m DataSelectorPatternDetails) String() string
func (m DataSelectorPatternDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteAttributeRequest wrapper for the DeleteAttribute operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteAttribute.go.html to see an example of how to use DeleteAttributeRequest.
type DeleteAttributeRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique attribute key.
AttributeKey *string `mandatory:"true" contributesTo:"path" name:"attributeKey"`
// 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"`
// 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 DeleteAttributeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAttributeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAttributeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAttributeRequest) String() string
func (request DeleteAttributeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteAttributeResponse wrapper for the DeleteAttribute operation
type DeleteAttributeResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteAttributeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAttributeResponse) String() string
DeleteAttributeTagRequest wrapper for the DeleteAttributeTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteAttributeTag.go.html to see an example of how to use DeleteAttributeTagRequest.
type DeleteAttributeTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique attribute key.
AttributeKey *string `mandatory:"true" contributesTo:"path" name:"attributeKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// 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"`
// 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 DeleteAttributeTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAttributeTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAttributeTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAttributeTagRequest) String() string
func (request DeleteAttributeTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteAttributeTagResponse wrapper for the DeleteAttributeTag operation
type DeleteAttributeTagResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteAttributeTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAttributeTagResponse) String() string
DeleteCatalogPrivateEndpointRequest wrapper for the DeleteCatalogPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteCatalogPrivateEndpoint.go.html to see an example of how to use DeleteCatalogPrivateEndpointRequest.
type DeleteCatalogPrivateEndpointRequest struct {
// Unique private reverse connection identifier.
CatalogPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"catalogPrivateEndpointId"`
// 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"`
// 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 DeleteCatalogPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCatalogPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCatalogPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCatalogPrivateEndpointRequest) String() string
func (request DeleteCatalogPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCatalogPrivateEndpointResponse wrapper for the DeleteCatalogPrivateEndpoint operation
type DeleteCatalogPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteCatalogPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCatalogPrivateEndpointResponse) String() string
DeleteCatalogRequest wrapper for the DeleteCatalog operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteCatalog.go.html to see an example of how to use DeleteCatalogRequest.
type DeleteCatalogRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// 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"`
// 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 DeleteCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCatalogRequest) String() string
func (request DeleteCatalogRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCatalogResponse wrapper for the DeleteCatalog operation
type DeleteCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCatalogResponse) String() string
DeleteConnectionRequest wrapper for the DeleteConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteConnection.go.html to see an example of how to use DeleteConnectionRequest.
type DeleteConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique connection key.
ConnectionKey *string `mandatory:"true" contributesTo:"path" name:"connectionKey"`
// 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"`
// 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 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
// 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"`
}
func (response DeleteConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConnectionResponse) String() string
DeleteCustomPropertyRequest wrapper for the DeleteCustomProperty operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteCustomProperty.go.html to see an example of how to use DeleteCustomPropertyRequest.
type DeleteCustomPropertyRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// Unique Custom Property key
CustomPropertyKey *string `mandatory:"true" contributesTo:"path" name:"customPropertyKey"`
// 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"`
// 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 DeleteCustomPropertyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCustomPropertyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCustomPropertyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCustomPropertyRequest) String() string
func (request DeleteCustomPropertyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCustomPropertyResponse wrapper for the DeleteCustomProperty operation
type DeleteCustomPropertyResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteCustomPropertyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCustomPropertyResponse) String() string
DeleteDataAssetRequest wrapper for the DeleteDataAsset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteDataAsset.go.html to see an example of how to use DeleteDataAssetRequest.
type DeleteDataAssetRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// 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"`
// 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 DeleteDataAssetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDataAssetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDataAssetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDataAssetRequest) String() string
func (request DeleteDataAssetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDataAssetResponse wrapper for the DeleteDataAsset operation
type DeleteDataAssetResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteDataAssetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDataAssetResponse) String() string
DeleteDataAssetTagRequest wrapper for the DeleteDataAssetTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteDataAssetTag.go.html to see an example of how to use DeleteDataAssetTagRequest.
type DeleteDataAssetTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// 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"`
// 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 DeleteDataAssetTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDataAssetTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDataAssetTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDataAssetTagRequest) String() string
func (request DeleteDataAssetTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDataAssetTagResponse wrapper for the DeleteDataAssetTag operation
type DeleteDataAssetTagResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteDataAssetTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDataAssetTagResponse) String() string
DeleteEntityRequest wrapper for the DeleteEntity operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteEntity.go.html to see an example of how to use DeleteEntityRequest.
type DeleteEntityRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// 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"`
// 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 DeleteEntityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteEntityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteEntityRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteEntityRequest) String() string
func (request DeleteEntityRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteEntityResponse wrapper for the DeleteEntity operation
type DeleteEntityResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteEntityResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteEntityResponse) String() string
DeleteEntityTagRequest wrapper for the DeleteEntityTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteEntityTag.go.html to see an example of how to use DeleteEntityTagRequest.
type DeleteEntityTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// 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"`
// 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 DeleteEntityTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteEntityTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteEntityTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteEntityTagRequest) String() string
func (request DeleteEntityTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteEntityTagResponse wrapper for the DeleteEntityTag operation
type DeleteEntityTagResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteEntityTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteEntityTagResponse) String() string
DeleteFolderRequest wrapper for the DeleteFolder operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteFolder.go.html to see an example of how to use DeleteFolderRequest.
type DeleteFolderRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique folder key.
FolderKey *string `mandatory:"true" contributesTo:"path" name:"folderKey"`
// 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"`
// 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 DeleteFolderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteFolderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteFolderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteFolderRequest) String() string
func (request DeleteFolderRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteFolderResponse wrapper for the DeleteFolder operation
type DeleteFolderResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteFolderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteFolderResponse) String() string
DeleteFolderTagRequest wrapper for the DeleteFolderTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteFolderTag.go.html to see an example of how to use DeleteFolderTagRequest.
type DeleteFolderTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique folder key.
FolderKey *string `mandatory:"true" contributesTo:"path" name:"folderKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// 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"`
// 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 DeleteFolderTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteFolderTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteFolderTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteFolderTagRequest) String() string
func (request DeleteFolderTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteFolderTagResponse wrapper for the DeleteFolderTag operation
type DeleteFolderTagResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteFolderTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteFolderTagResponse) String() string
DeleteGlossaryRequest wrapper for the DeleteGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteGlossary.go.html to see an example of how to use DeleteGlossaryRequest.
type DeleteGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// 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"`
// 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 DeleteGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGlossaryRequest) String() string
func (request DeleteGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteGlossaryResponse wrapper for the DeleteGlossary operation
type DeleteGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGlossaryResponse) String() string
DeleteJobDefinitionRequest wrapper for the DeleteJobDefinition operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteJobDefinition.go.html to see an example of how to use DeleteJobDefinitionRequest.
type DeleteJobDefinitionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job definition key.
JobDefinitionKey *string `mandatory:"true" contributesTo:"path" name:"jobDefinitionKey"`
// 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"`
// 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 DeleteJobDefinitionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteJobDefinitionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteJobDefinitionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteJobDefinitionRequest) String() string
func (request DeleteJobDefinitionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteJobDefinitionResponse wrapper for the DeleteJobDefinition operation
type DeleteJobDefinitionResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteJobDefinitionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteJobDefinitionResponse) String() string
DeleteJobRequest wrapper for the DeleteJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteJob.go.html to see an example of how to use DeleteJobRequest.
type DeleteJobRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// 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"`
// 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 DeleteJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteJobRequest) String() string
func (request DeleteJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteJobResponse wrapper for the DeleteJob operation
type DeleteJobResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteJobResponse) String() string
DeleteMetastoreRequest wrapper for the DeleteMetastore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteMetastore.go.html to see an example of how to use DeleteMetastoreRequest.
type DeleteMetastoreRequest struct {
// The metastore's OCID.
MetastoreId *string `mandatory:"true" contributesTo:"path" name:"metastoreId"`
// 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"`
// 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 DeleteMetastoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteMetastoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteMetastoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteMetastoreRequest) String() string
func (request DeleteMetastoreRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteMetastoreResponse wrapper for the DeleteMetastore operation
type DeleteMetastoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteMetastoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteMetastoreResponse) String() string
DeleteNamespaceRequest wrapper for the DeleteNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteNamespace.go.html to see an example of how to use DeleteNamespaceRequest.
type DeleteNamespaceRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// 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"`
// 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 DeleteNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteNamespaceRequest) String() string
func (request DeleteNamespaceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteNamespaceResponse wrapper for the DeleteNamespace operation
type DeleteNamespaceResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteNamespaceResponse) String() string
DeletePatternRequest wrapper for the DeletePattern operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeletePattern.go.html to see an example of how to use DeletePatternRequest.
type DeletePatternRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique pattern key.
PatternKey *string `mandatory:"true" contributesTo:"path" name:"patternKey"`
// 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"`
// 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 DeletePatternRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePatternRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePatternRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePatternRequest) String() string
func (request DeletePatternRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeletePatternResponse wrapper for the DeletePattern operation
type DeletePatternResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeletePatternResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePatternResponse) String() string
DeleteTermRelationshipRequest wrapper for the DeleteTermRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteTermRelationship.go.html to see an example of how to use DeleteTermRelationshipRequest.
type DeleteTermRelationshipRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// Unique glossary term relationship key.
TermRelationshipKey *string `mandatory:"true" contributesTo:"path" name:"termRelationshipKey"`
// 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"`
// 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 DeleteTermRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteTermRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTermRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTermRelationshipRequest) String() string
func (request DeleteTermRelationshipRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteTermRelationshipResponse wrapper for the DeleteTermRelationship operation
type DeleteTermRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteTermRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTermRelationshipResponse) String() string
DeleteTermRequest wrapper for the DeleteTerm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DeleteTerm.go.html to see an example of how to use DeleteTermRequest.
type DeleteTermRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// 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"`
// 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 DeleteTermRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteTermRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTermRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTermRequest) String() string
func (request DeleteTermRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteTermResponse wrapper for the DeleteTerm operation
type DeleteTermResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response DeleteTermResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTermResponse) String() string
DerivedLogicalEntities Entities derived from the application of a pattern to a list of file paths.
type DerivedLogicalEntities struct {
// The name of the derived logical entity. The group name of the unmatched files will be UNMATCHED
Name *string `mandatory:"false" json:"name"`
// The expression realized after resolving qualifiers . Used in deriving this logical entity
RealizedExpression *string `mandatory:"false" json:"realizedExpression"`
// The list of file paths that belong to the grouping of logical entity or UNMATCHED for which realizedExpression is a selector.
FilesInLogicalGrouping []string `mandatory:"false" json:"filesInLogicalGrouping"`
}
func (m DerivedLogicalEntities) String() string
func (m DerivedLogicalEntities) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DetachCatalogPrivateEndpointDetails Information about the detaching the private endpoint resource from a catalog
type DetachCatalogPrivateEndpointDetails struct {
// The identifier of the private endpoint to be detached from catalog resource.
CatalogPrivateEndpointId *string `mandatory:"true" json:"catalogPrivateEndpointId"`
}
func (m DetachCatalogPrivateEndpointDetails) String() string
func (m DetachCatalogPrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DetachCatalogPrivateEndpointRequest wrapper for the DetachCatalogPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DetachCatalogPrivateEndpoint.go.html to see an example of how to use DetachCatalogPrivateEndpointRequest.
type DetachCatalogPrivateEndpointRequest struct {
// Details for private reverse connection endpoint to be used for attachment
DetachCatalogPrivateEndpointDetails `contributesTo:"body"`
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// 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"`
// 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 DetachCatalogPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetachCatalogPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetachCatalogPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetachCatalogPrivateEndpointRequest) String() string
func (request DetachCatalogPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DetachCatalogPrivateEndpointResponse wrapper for the DetachCatalogPrivateEndpoint operation
type DetachCatalogPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DetachCatalogPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetachCatalogPrivateEndpointResponse) String() string
DisassociateCustomPropertyRequest wrapper for the DisassociateCustomProperty operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/DisassociateCustomProperty.go.html to see an example of how to use DisassociateCustomPropertyRequest.
type DisassociateCustomPropertyRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique type key.
TypeKey *string `mandatory:"true" contributesTo:"path" name:"typeKey"`
// The information used to remove the custom properties.
DisassociateCustomPropertyDetails TypeCustomPropertyDetails `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 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 DisassociateCustomPropertyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DisassociateCustomPropertyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DisassociateCustomPropertyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DisassociateCustomPropertyRequest) String() string
func (request DisassociateCustomPropertyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DisassociateCustomPropertyResponse wrapper for the DisassociateCustomProperty operation
type DisassociateCustomPropertyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ModelType instance
ModelType `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response DisassociateCustomPropertyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DisassociateCustomPropertyResponse) String() string
Entity Data entity details. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view' in a database, or a single logical file structure that one or many files may match.
type Entity struct {
// Unique data entity key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of a data entity.
Description *string `mandatory:"false" json:"description"`
// The date and time the data entity was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the data entity. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created this object in the data catalog.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated this object in the data catalog.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// The current state of the data entity.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Unique external key of this object in the source system.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Key of the associated pattern if this is a logical entity.
PatternKey *string `mandatory:"false" json:"patternKey"`
// The expression realized after resolving qualifiers . Used in deriving this logical entity
RealizedExpression *string `mandatory:"false" json:"realizedExpression"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// The date and time the entity was harvested, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeHarvested *common.SDKTime `mandatory:"false" json:"timeHarvested"`
// List of objects and their relationships to this entity.
ObjectRelationships []ObjectRelationship `mandatory:"false" json:"objectRelationships"`
// Time that the data entities status was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStatusUpdated *common.SDKTime `mandatory:"false" json:"timeStatusUpdated"`
// Property that identifies if the object is a physical object (materialized) or virtual/logical object
// defined on other objects.
IsLogical *bool `mandatory:"false" json:"isLogical"`
// Property that identifies if an object is a sub object of a physical or materialized parent object.
IsPartition *bool `mandatory:"false" json:"isPartition"`
// Unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Key of the associated folder.
FolderKey *string `mandatory:"false" json:"folderKey"`
// Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.
FolderName *string `mandatory:"false" json:"folderName"`
// Full path of the data entity.
Path *string `mandatory:"false" json:"path"`
// Status of the object as updated by the harvest process.
HarvestStatus HarvestStatusEnum `mandatory:"false" json:"harvestStatus,omitempty"`
// Key of the last harvest process to update this object.
LastJobKey *string `mandatory:"false" json:"lastJobKey"`
// The type of data entity object. Type key's can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// URI to the data entity instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// URL of the data entity in the object store.
ObjectStorageUrl *string `mandatory:"false" json:"objectStorageUrl"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the entity type. Each entity type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data entities have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m Entity) String() string
func (m Entity) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EntityCollection Results of a data entities listing. Data entities are representation of a dataset with a set of attributes.
type EntityCollection struct {
// Collection of data entities.
Items []EntitySummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m EntityCollection) String() string
func (m EntityCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EntityLineage Lineage for a data entity.
type EntityLineage struct {
// Object level at which the lineage is returned.
Level *int `mandatory:"true" json:"level"`
// Direction of the lineage returned.
Direction LineageDirectionEnum `mandatory:"true" json:"direction"`
// Set of objects that are involved in the lineage.
Objects []LineageObject `mandatory:"false" json:"objects"`
// Set of relationships between the objects in the 'objects' set.
Relationships []LineageRelationship `mandatory:"false" json:"relationships"`
// A map of maps that contains additional information in explanation of the lineage returned. The map keys are
// categories of information and the values are maps of annotation names to their corresponding values.
// Every annotation is contained inside a category.
// Example: `{"annotations": { "category": { "key": "value"}}}`
Annotations map[string]map[string]string `mandatory:"false" json:"annotations"`
}
func (m EntityLineage) String() string
func (m EntityLineage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EntitySummary Summary of an data entity. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view' in a database, or a single logical file structure that one or many files may match.
type EntitySummary struct {
// Unique data entity key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of a data entity.
Description *string `mandatory:"false" json:"description"`
// Property that identifies if the object is a physical object (materialized) or virtual/logical object
// defined on other objects.
IsLogical *bool `mandatory:"false" json:"isLogical"`
// Property that identifies if an object is a sub object of a physical or materialized parent object.
IsPartition *bool `mandatory:"false" json:"isPartition"`
// Unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Key of the associated folder.
FolderKey *string `mandatory:"false" json:"folderKey"`
// Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.
FolderName *string `mandatory:"false" json:"folderName"`
// Unique external key of this object in the source system.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Key of the associated pattern if this is a logical entity.
PatternKey *string `mandatory:"false" json:"patternKey"`
// The type of data entity object. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// The expression realized after resolving qualifiers . Used in deriving this logical entity
RealizedExpression *string `mandatory:"false" json:"realizedExpression"`
// Full path of the data entity.
Path *string `mandatory:"false" json:"path"`
// The date and time the data entity was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the data entity. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who updated this object in the data catalog.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// URI to the data entity instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// URL of the data entity in the object store.
ObjectStorageUrl *string `mandatory:"false" json:"objectStorageUrl"`
// State of the data entity.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A map of maps that contains the properties which are specific to the entity type. Each entity type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data entities have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m EntitySummary) String() string
func (m EntitySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EntityTag Represents an association of an entity to a term.
type EntityTag struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Name of the tag which matches the term name.
Name *string `mandatory:"false" json:"name"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// The current state of the tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// OCID of the user who created the tag.
CreatedById *string `mandatory:"false" json:"createdById"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The unique key of the parent entity.
EntityKey *string `mandatory:"false" json:"entityKey"`
}
func (m EntityTag) String() string
func (m EntityTag) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EntityTagCollection Results of an entity tags listing. Entity tags allow assciation of business terms with entities.
type EntityTagCollection struct {
// Collection of entity tags.
Items []EntityTagSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m EntityTagCollection) String() string
func (m EntityTagCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EntityTagSummary Summary of an entity tag.
type EntityTagSummary struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Name of the tag that matches the term name.
Name *string `mandatory:"false" json:"name"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// Unique id of the parent glossary of the term.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// State of the Tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The unique key of the parent entity.
EntityKey *string `mandatory:"false" json:"entityKey"`
}
func (m EntityTagSummary) String() string
func (m EntityTagSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EventConfig Describes an event configuration, for a given object type and property. Primarily, whether a property change will result in an event being emitted.
type EventConfig struct {
// Unique type key identifier.
TypeId *string `mandatory:"false" json:"typeId"`
// Name of the type.
TypeName *string `mandatory:"false" json:"typeName"`
// Unique property key identifier.
PropertyId *string `mandatory:"false" json:"propertyId"`
// Name of the property.
PropertyName *string `mandatory:"false" json:"propertyName"`
// Status of the configuration.
EventConfigStatus EventConfigStatusEnum `mandatory:"false" json:"eventConfigStatus,omitempty"`
// The date and time the event was configured, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the configuration. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the configuration.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who last modified the configuration.
UpdatedById *string `mandatory:"false" json:"updatedById"`
}
func (m EventConfig) String() string
func (m EventConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EventConfigStatusEnum Enum with underlying type: string
type EventConfigStatusEnum string
Set of constants representing the allowable values for EventConfigStatusEnum
const (
EventConfigStatusEnabled EventConfigStatusEnum = "ENABLED"
EventConfigStatusDisabled EventConfigStatusEnum = "DISABLED"
)
func GetEventConfigStatusEnumValues() []EventConfigStatusEnum
GetEventConfigStatusEnumValues Enumerates the set of values for EventConfigStatusEnum
func GetMappingEventConfigStatusEnum(val string) (EventConfigStatusEnum, bool)
GetMappingEventConfigStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ExpandTreeForGlossaryRequest wrapper for the ExpandTreeForGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ExpandTreeForGlossary.go.html to see an example of how to use ExpandTreeForGlossaryRequest.
type ExpandTreeForGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ExpandTreeForGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExpandTreeForGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExpandTreeForGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExpandTreeForGlossaryRequest) String() string
func (request ExpandTreeForGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExpandTreeForGlossaryResponse wrapper for the ExpandTreeForGlossary operation
type ExpandTreeForGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// The []GlossaryTreeElement instance
Items []GlossaryTreeElement `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response ExpandTreeForGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExpandTreeForGlossaryResponse) String() string
ExportDataAssetDetails The details of what needs to be exported.
type ExportDataAssetDetails struct {
// Array of objects and their child types to be selected for export.
ExportScope []DataAssetExportScope `mandatory:"false" json:"exportScope"`
}
func (m ExportDataAssetDetails) String() string
func (m ExportDataAssetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportGlossaryRequest wrapper for the ExportGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ExportGlossary.go.html to see an example of how to use ExportGlossaryRequest.
type ExportGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Specify if the relationship metadata is exported for the glossary.
IsRelationshipExported *bool `mandatory:"false" contributesTo:"query" name:"isRelationshipExported"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ExportGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExportGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportGlossaryRequest) String() string
func (request ExportGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportGlossaryResponse wrapper for the ExportGlossary operation
type ExportGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// The string instance
Value *string `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response ExportGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportGlossaryResponse) String() string
FacetedSearchAggregation Aggregation/facets on properties of data object.
type FacetedSearchAggregation struct {
// Name of data object property
Type *string `mandatory:"false" json:"type"`
// Count of number of data objects having property.
Aggregation map[string]int64 `mandatory:"false" json:"aggregation"`
// Data type of object property.
DataType *string `mandatory:"false" json:"dataType"`
// Type of property that indicates if it was defined by the user or system.
// CUSTOM_PROPERTY is defined by the user on a data object.
// DEFAULT_PROPERTY is defined by the system on a data object.
PropertyType FacetedSearchAggregationPropertyTypeEnum `mandatory:"false" json:"propertyType,omitempty"`
}
func (m FacetedSearchAggregation) String() string
func (m FacetedSearchAggregation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FacetedSearchAggregationPropertyTypeEnum Enum with underlying type: string
type FacetedSearchAggregationPropertyTypeEnum string
Set of constants representing the allowable values for FacetedSearchAggregationPropertyTypeEnum
const (
FacetedSearchAggregationPropertyTypeCustomProperty FacetedSearchAggregationPropertyTypeEnum = "CUSTOM_PROPERTY"
FacetedSearchAggregationPropertyTypeDefaultProperty FacetedSearchAggregationPropertyTypeEnum = "DEFAULT_PROPERTY"
)
func GetFacetedSearchAggregationPropertyTypeEnumValues() []FacetedSearchAggregationPropertyTypeEnum
GetFacetedSearchAggregationPropertyTypeEnumValues Enumerates the set of values for FacetedSearchAggregationPropertyTypeEnum
func GetMappingFacetedSearchAggregationPropertyTypeEnum(val string) (FacetedSearchAggregationPropertyTypeEnum, bool)
GetMappingFacetedSearchAggregationPropertyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FacetedSearchCustomProperty Details about custom property
type FacetedSearchCustomProperty struct {
// Name of custom property field
Name *string `mandatory:"false" json:"name"`
// Value of the custom property field
Value *string `mandatory:"false" json:"value"`
// Data type of the custom property field
DataType *string `mandatory:"false" json:"dataType"`
}
func (m FacetedSearchCustomProperty) String() string
func (m FacetedSearchCustomProperty) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FacetedSearchDateFilterRequest Object with date filter criteria
type FacetedSearchDateFilterRequest struct {
// Date field name that needs to be filtered by. Acceptable fields include TimeCreated and TimeUpdated.
FieldName *string `mandatory:"false" json:"fieldName"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAfter *common.SDKTime `mandatory:"false" json:"timeAfter"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeBefore *common.SDKTime `mandatory:"false" json:"timeBefore"`
}
func (m FacetedSearchDateFilterRequest) String() string
func (m FacetedSearchDateFilterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FacetedSearchFilterRequest Object with details about filter criteria.
type FacetedSearchFilterRequest struct {
// Object with date filter criteria
SearchDateFilters []FacetedSearchDateFilterRequest `mandatory:"false" json:"searchDateFilters"`
// Object with string filter criteria
SearchStringFilters []FacetedSearchStringFilterRequest `mandatory:"false" json:"searchStringFilters"`
}
func (m FacetedSearchFilterRequest) String() string
func (m FacetedSearchFilterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FacetedSearchSortRequest Object with sort criteria details
type FacetedSearchSortRequest struct {
// Filed name that needs to be sorted by.
SortBy *string `mandatory:"false" json:"sortBy"`
// Sort order for search results.
SortOrder FacetedSearchSortRequestSortOrderEnum `mandatory:"false" json:"sortOrder,omitempty"`
}
func (m FacetedSearchSortRequest) String() string
func (m FacetedSearchSortRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FacetedSearchSortRequestSortOrderEnum Enum with underlying type: string
type FacetedSearchSortRequestSortOrderEnum string
Set of constants representing the allowable values for FacetedSearchSortRequestSortOrderEnum
const (
FacetedSearchSortRequestSortOrderAsc FacetedSearchSortRequestSortOrderEnum = "ASC"
FacetedSearchSortRequestSortOrderDesc FacetedSearchSortRequestSortOrderEnum = "DESC"
)
func GetFacetedSearchSortRequestSortOrderEnumValues() []FacetedSearchSortRequestSortOrderEnum
GetFacetedSearchSortRequestSortOrderEnumValues Enumerates the set of values for FacetedSearchSortRequestSortOrderEnum
func GetMappingFacetedSearchSortRequestSortOrderEnum(val string) (FacetedSearchSortRequestSortOrderEnum, bool)
GetMappingFacetedSearchSortRequestSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
FacetedSearchStringFilterRequest Object with string filter criteria
type FacetedSearchStringFilterRequest struct {
// String/boolean/numerical field name that needs to be filtered by.
// Acceptable field names: CatalogType, AttributeType, FolderType, DataAssetType, CreatedBy, UpdatedBy, Term, Tag, DataAssetName, LifeCycleState.
Field *string `mandatory:"false" json:"field"`
// Array of values that the search results needs to be filtered by.
// Acceptable values for field 'CatalogType': DataAsset, Folder, DataEntity, Attribute, Term, Category, Glossary, Pattern, Job, Schedule, CustomProperty.
// For other fields, acceptable values can be derived by inspecting the data object.
Values []string `mandatory:"false" json:"values"`
}
func (m FacetedSearchStringFilterRequest) String() string
func (m FacetedSearchStringFilterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchEntityLineageDetails The information needed to obtain desired lineage.
type FetchEntityLineageDetails struct {
// Object level at which the lineage is returned.
Level *int `mandatory:"false" json:"level"`
// Direction of the lineage returned.
Direction LineageDirectionEnum `mandatory:"false" json:"direction,omitempty"`
// Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be
// expanded inline in the lineage returned.
IsIntraLineage *bool `mandatory:"false" json:"isIntraLineage"`
// Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding
// to the object whose object key is passed is returned.
IntraLineageObjectKey *string `mandatory:"false" json:"intraLineageObjectKey"`
}
func (m FetchEntityLineageDetails) String() string
func (m FetchEntityLineageDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchEntityLineageRequest wrapper for the FetchEntityLineage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/FetchEntityLineage.go.html to see an example of how to use FetchEntityLineageRequest.
type FetchEntityLineageRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// The information needed to obtain desired lineage.
FetchEntityLineageDetails `contributesTo:"body"`
// 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 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 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 FetchEntityLineageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request FetchEntityLineageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request FetchEntityLineageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request FetchEntityLineageRequest) String() string
func (request FetchEntityLineageRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchEntityLineageResponse wrapper for the FetchEntityLineage operation
type FetchEntityLineageResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EntityLineage instances
EntityLineage `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response FetchEntityLineageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response FetchEntityLineageResponse) String() string
Folder A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.
type Folder struct {
// Unique folder key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of a folder.
Description *string `mandatory:"false" json:"description"`
// The unique key of the containing folder or null if there is no parent folder.
ParentFolderKey *string `mandatory:"false" json:"parentFolderKey"`
// The type of folder object. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// The date and time the folder was harvested, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeHarvested *common.SDKTime `mandatory:"false" json:"timeHarvested"`
// List of objects and their relationships to this folder.
ObjectRelationships []ObjectRelationship `mandatory:"false" json:"objectRelationships"`
// Full path of the folder.
Path *string `mandatory:"false" json:"path"`
// The key of the associated data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the folder type. Each folder type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// folders have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
// Unique external key of this object in the source system.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// The date and time the folder was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the folder. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the folder.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who modified the folder.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// The current state of the folder.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Status of the object as updated by the harvest process.
HarvestStatus HarvestStatusEnum `mandatory:"false" json:"harvestStatus,omitempty"`
// The key of the last harvest process to update the metadata of this object.
LastJobKey *string `mandatory:"false" json:"lastJobKey"`
// URI to the folder instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// URL of the folder in the object store.
ObjectStorageUrl *string `mandatory:"false" json:"objectStorageUrl"`
}
func (m Folder) String() string
func (m Folder) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FolderCollection Results of a folders listing. Folders are external organization concept that groups data entities.
type FolderCollection struct {
// Collection of folders.
Items []FolderSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m FolderCollection) String() string
func (m FolderCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FolderSummary Summary of a folder. A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.
type FolderSummary struct {
// Unique folder key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of a folder.
Description *string `mandatory:"false" json:"description"`
// The unique key of the parent data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// The key of the containing folder or null if there is no parent.
ParentFolderKey *string `mandatory:"false" json:"parentFolderKey"`
// The type of folder object. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// Full path of the folder.
Path *string `mandatory:"false" json:"path"`
// Unique external key of this object from the source systems.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// The date and time the folder was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the folder was last updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2019-03-25T21:10:29.600Z
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// URI of the folder resource within the data catalog API.
Uri *string `mandatory:"false" json:"uri"`
// URL of the folder in the object store.
ObjectStorageUrl *string `mandatory:"false" json:"objectStorageUrl"`
// State of the folder.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m FolderSummary) String() string
func (m FolderSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FolderTag Represents an association of a folder to a term.
type FolderTag struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Name of the tag which matches the term name.
Name *string `mandatory:"false" json:"name"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// The current state of the tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// OCID of the user who created the tag.
CreatedById *string `mandatory:"false" json:"createdById"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The unique key of the folder associated with this tag.
FolderKey *string `mandatory:"false" json:"folderKey"`
}
func (m FolderTag) String() string
func (m FolderTag) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FolderTagCollection Results of a folders tag listing. Folder tags allow association of folder objects to business terms.
type FolderTagCollection struct {
// Collection of folder tags.
Items []FolderTagSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m FolderTagCollection) String() string
func (m FolderTagCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FolderTagSummary Summary of a folder tag.
type FolderTagSummary struct {
// Unique tag key that is immutable.
Key *string `mandatory:"true" json:"key"`
// The date and time the tag was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Name of the tag that matches the term name.
Name *string `mandatory:"false" json:"name"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Unique key of the related term.
TermKey *string `mandatory:"false" json:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" json:"termPath"`
// Description of the related term.
TermDescription *string `mandatory:"false" json:"termDescription"`
// Unique id of the parent glossary of the term.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// State of the Tag.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The unique key of the parent folder.
FolderKey *string `mandatory:"false" json:"folderKey"`
}
func (m FolderTagSummary) String() string
func (m FolderTagSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetAttributeFieldsEnum Enum with underlying type: string
type GetAttributeFieldsEnum string
Set of constants representing the allowable values for GetAttributeFieldsEnum
const (
GetAttributeFieldsKey GetAttributeFieldsEnum = "key"
GetAttributeFieldsDisplayname GetAttributeFieldsEnum = "displayName"
GetAttributeFieldsDescription GetAttributeFieldsEnum = "description"
GetAttributeFieldsEntitykey GetAttributeFieldsEnum = "entityKey"
GetAttributeFieldsLifecyclestate GetAttributeFieldsEnum = "lifecycleState"
GetAttributeFieldsTimecreated GetAttributeFieldsEnum = "timeCreated"
GetAttributeFieldsTimeupdated GetAttributeFieldsEnum = "timeUpdated"
GetAttributeFieldsCreatedbyid GetAttributeFieldsEnum = "createdById"
GetAttributeFieldsUpdatedbyid GetAttributeFieldsEnum = "updatedById"
GetAttributeFieldsExternaldatatype GetAttributeFieldsEnum = "externalDataType"
GetAttributeFieldsExternalkey GetAttributeFieldsEnum = "externalKey"
GetAttributeFieldsIsincrementaldata GetAttributeFieldsEnum = "isIncrementalData"
GetAttributeFieldsIsnullable GetAttributeFieldsEnum = "isNullable"
GetAttributeFieldsLength GetAttributeFieldsEnum = "length"
GetAttributeFieldsPosition GetAttributeFieldsEnum = "position"
GetAttributeFieldsPrecision GetAttributeFieldsEnum = "precision"
GetAttributeFieldsScale GetAttributeFieldsEnum = "scale"
GetAttributeFieldsTimeexternal GetAttributeFieldsEnum = "timeExternal"
GetAttributeFieldsUri GetAttributeFieldsEnum = "uri"
GetAttributeFieldsProperties GetAttributeFieldsEnum = "properties"
GetAttributeFieldsPath GetAttributeFieldsEnum = "path"
GetAttributeFieldsMincollectioncount GetAttributeFieldsEnum = "minCollectionCount"
GetAttributeFieldsMaxcollectioncount GetAttributeFieldsEnum = "maxCollectionCount"
GetAttributeFieldsDatatypeentitykey GetAttributeFieldsEnum = "datatypeEntityKey"
GetAttributeFieldsExternaldatatypeentitykey GetAttributeFieldsEnum = "externalDatatypeEntityKey"
GetAttributeFieldsParentattributekey GetAttributeFieldsEnum = "parentAttributeKey"
GetAttributeFieldsExternalparentattributekey GetAttributeFieldsEnum = "externalParentAttributeKey"
GetAttributeFieldsTypekey GetAttributeFieldsEnum = "typeKey"
)
func GetGetAttributeFieldsEnumValues() []GetAttributeFieldsEnum
GetGetAttributeFieldsEnumValues Enumerates the set of values for GetAttributeFieldsEnum
func GetMappingGetAttributeFieldsEnum(val string) (GetAttributeFieldsEnum, bool)
GetMappingGetAttributeFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetAttributeRequest wrapper for the GetAttribute operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetAttribute.go.html to see an example of how to use GetAttributeRequest.
type GetAttributeRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique attribute key.
AttributeKey *string `mandatory:"true" contributesTo:"path" name:"attributeKey"`
// Indicates whether the list of objects and their relationships to this object will be provided in the response.
IsIncludeObjectRelationships *bool `mandatory:"false" contributesTo:"query" name:"isIncludeObjectRelationships"`
// Specifies the fields to return in an entity attribute response.
Fields []GetAttributeFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetAttributeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAttributeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAttributeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAttributeRequest) String() string
func (request GetAttributeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetAttributeResponse wrapper for the GetAttribute operation
type GetAttributeResponse struct {
// The underlying http response
RawResponse *http.Response
// The Attribute instance
Attribute `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetAttributeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAttributeResponse) String() string
GetAttributeTagFieldsEnum Enum with underlying type: string
type GetAttributeTagFieldsEnum string
Set of constants representing the allowable values for GetAttributeTagFieldsEnum
const (
GetAttributeTagFieldsKey GetAttributeTagFieldsEnum = "key"
GetAttributeTagFieldsName GetAttributeTagFieldsEnum = "name"
GetAttributeTagFieldsTermkey GetAttributeTagFieldsEnum = "termKey"
GetAttributeTagFieldsTermpath GetAttributeTagFieldsEnum = "termPath"
GetAttributeTagFieldsTermdescription GetAttributeTagFieldsEnum = "termDescription"
GetAttributeTagFieldsLifecyclestate GetAttributeTagFieldsEnum = "lifecycleState"
GetAttributeTagFieldsTimecreated GetAttributeTagFieldsEnum = "timeCreated"
GetAttributeTagFieldsCreatedbyid GetAttributeTagFieldsEnum = "createdById"
GetAttributeTagFieldsUri GetAttributeTagFieldsEnum = "uri"
GetAttributeTagFieldsAttributekey GetAttributeTagFieldsEnum = "attributeKey"
)
func GetGetAttributeTagFieldsEnumValues() []GetAttributeTagFieldsEnum
GetGetAttributeTagFieldsEnumValues Enumerates the set of values for GetAttributeTagFieldsEnum
func GetMappingGetAttributeTagFieldsEnum(val string) (GetAttributeTagFieldsEnum, bool)
GetMappingGetAttributeTagFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetAttributeTagRequest wrapper for the GetAttributeTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetAttributeTag.go.html to see an example of how to use GetAttributeTagRequest.
type GetAttributeTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique attribute key.
AttributeKey *string `mandatory:"true" contributesTo:"path" name:"attributeKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// Specifies the fields to return in an entity attribute tag response.
Fields []GetAttributeTagFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetAttributeTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAttributeTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAttributeTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAttributeTagRequest) String() string
func (request GetAttributeTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetAttributeTagResponse wrapper for the GetAttributeTag operation
type GetAttributeTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The AttributeTag instance
AttributeTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetAttributeTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAttributeTagResponse) String() string
GetCatalogPrivateEndpointRequest wrapper for the GetCatalogPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetCatalogPrivateEndpoint.go.html to see an example of how to use GetCatalogPrivateEndpointRequest.
type GetCatalogPrivateEndpointRequest struct {
// Unique private reverse connection identifier.
CatalogPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"catalogPrivateEndpointId"`
// 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 GetCatalogPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCatalogPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCatalogPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCatalogPrivateEndpointRequest) String() string
func (request GetCatalogPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCatalogPrivateEndpointResponse wrapper for the GetCatalogPrivateEndpoint operation
type GetCatalogPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The CatalogPrivateEndpoint instance
CatalogPrivateEndpoint `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"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetCatalogPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCatalogPrivateEndpointResponse) String() string
GetCatalogRequest wrapper for the GetCatalog operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetCatalog.go.html to see an example of how to use GetCatalogRequest.
type GetCatalogRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// 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 GetCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCatalogRequest) String() string
func (request GetCatalogRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCatalogResponse wrapper for the GetCatalog operation
type GetCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// The Catalog instance
Catalog `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCatalogResponse) String() string
GetConnectionFieldsEnum Enum with underlying type: string
type GetConnectionFieldsEnum string
Set of constants representing the allowable values for GetConnectionFieldsEnum
const (
GetConnectionFieldsKey GetConnectionFieldsEnum = "key"
GetConnectionFieldsDisplayname GetConnectionFieldsEnum = "displayName"
GetConnectionFieldsDescription GetConnectionFieldsEnum = "description"
GetConnectionFieldsDataassetkey GetConnectionFieldsEnum = "dataAssetKey"
GetConnectionFieldsTypekey GetConnectionFieldsEnum = "typeKey"
GetConnectionFieldsTimecreated GetConnectionFieldsEnum = "timeCreated"
GetConnectionFieldsTimeupdated GetConnectionFieldsEnum = "timeUpdated"
GetConnectionFieldsCreatedbyid GetConnectionFieldsEnum = "createdById"
GetConnectionFieldsUpdatedbyid GetConnectionFieldsEnum = "updatedById"
GetConnectionFieldsProperties GetConnectionFieldsEnum = "properties"
GetConnectionFieldsExternalkey GetConnectionFieldsEnum = "externalKey"
GetConnectionFieldsTimestatusupdated GetConnectionFieldsEnum = "timeStatusUpdated"
GetConnectionFieldsLifecyclestate GetConnectionFieldsEnum = "lifecycleState"
GetConnectionFieldsIsdefault GetConnectionFieldsEnum = "isDefault"
GetConnectionFieldsUri GetConnectionFieldsEnum = "uri"
)
func GetGetConnectionFieldsEnumValues() []GetConnectionFieldsEnum
GetGetConnectionFieldsEnumValues Enumerates the set of values for GetConnectionFieldsEnum
func GetMappingGetConnectionFieldsEnum(val string) (GetConnectionFieldsEnum, bool)
GetMappingGetConnectionFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetConnectionRequest wrapper for the GetConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetConnection.go.html to see an example of how to use GetConnectionRequest.
type GetConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique connection key.
ConnectionKey *string `mandatory:"true" contributesTo:"path" name:"connectionKey"`
// Specifies the fields to return in a connection response.
Fields []GetConnectionFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConnectionResponse) String() string
GetCustomPropertyFieldsEnum Enum with underlying type: string
type GetCustomPropertyFieldsEnum string
Set of constants representing the allowable values for GetCustomPropertyFieldsEnum
const (
GetCustomPropertyFieldsKey GetCustomPropertyFieldsEnum = "key"
GetCustomPropertyFieldsDisplayname GetCustomPropertyFieldsEnum = "displayName"
GetCustomPropertyFieldsDescription GetCustomPropertyFieldsEnum = "description"
GetCustomPropertyFieldsDatatype GetCustomPropertyFieldsEnum = "dataType"
GetCustomPropertyFieldsNamespacename GetCustomPropertyFieldsEnum = "namespaceName"
GetCustomPropertyFieldsLifecyclestate GetCustomPropertyFieldsEnum = "lifecycleState"
GetCustomPropertyFieldsTimecreated GetCustomPropertyFieldsEnum = "timeCreated"
GetCustomPropertyFieldsTimeupdated GetCustomPropertyFieldsEnum = "timeUpdated"
GetCustomPropertyFieldsCreatedbyid GetCustomPropertyFieldsEnum = "createdById"
GetCustomPropertyFieldsUpdatedbyid GetCustomPropertyFieldsEnum = "updatedById"
GetCustomPropertyFieldsProperties GetCustomPropertyFieldsEnum = "properties"
)
func GetGetCustomPropertyFieldsEnumValues() []GetCustomPropertyFieldsEnum
GetGetCustomPropertyFieldsEnumValues Enumerates the set of values for GetCustomPropertyFieldsEnum
func GetMappingGetCustomPropertyFieldsEnum(val string) (GetCustomPropertyFieldsEnum, bool)
GetMappingGetCustomPropertyFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetCustomPropertyRequest wrapper for the GetCustomProperty operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetCustomProperty.go.html to see an example of how to use GetCustomPropertyRequest.
type GetCustomPropertyRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// Unique Custom Property key
CustomPropertyKey *string `mandatory:"true" contributesTo:"path" name:"customPropertyKey"`
// Specifies the fields to return in a custom property response.
Fields []GetCustomPropertyFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetCustomPropertyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCustomPropertyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCustomPropertyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCustomPropertyRequest) String() string
func (request GetCustomPropertyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCustomPropertyResponse wrapper for the GetCustomProperty operation
type GetCustomPropertyResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomProperty instance
CustomProperty `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetCustomPropertyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCustomPropertyResponse) String() string
GetDataAssetFieldsEnum Enum with underlying type: string
type GetDataAssetFieldsEnum string
Set of constants representing the allowable values for GetDataAssetFieldsEnum
const (
GetDataAssetFieldsKey GetDataAssetFieldsEnum = "key"
GetDataAssetFieldsDisplayname GetDataAssetFieldsEnum = "displayName"
GetDataAssetFieldsDescription GetDataAssetFieldsEnum = "description"
GetDataAssetFieldsCatalogid GetDataAssetFieldsEnum = "catalogId"
GetDataAssetFieldsExternalkey GetDataAssetFieldsEnum = "externalKey"
GetDataAssetFieldsTypekey GetDataAssetFieldsEnum = "typeKey"
GetDataAssetFieldsLifecyclestate GetDataAssetFieldsEnum = "lifecycleState"
GetDataAssetFieldsTimecreated GetDataAssetFieldsEnum = "timeCreated"
GetDataAssetFieldsTimeupdated GetDataAssetFieldsEnum = "timeUpdated"
GetDataAssetFieldsCreatedbyid GetDataAssetFieldsEnum = "createdById"
GetDataAssetFieldsUpdatedbyid GetDataAssetFieldsEnum = "updatedById"
GetDataAssetFieldsUri GetDataAssetFieldsEnum = "uri"
GetDataAssetFieldsProperties GetDataAssetFieldsEnum = "properties"
)
func GetGetDataAssetFieldsEnumValues() []GetDataAssetFieldsEnum
GetGetDataAssetFieldsEnumValues Enumerates the set of values for GetDataAssetFieldsEnum
func GetMappingGetDataAssetFieldsEnum(val string) (GetDataAssetFieldsEnum, bool)
GetMappingGetDataAssetFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetDataAssetRequest wrapper for the GetDataAsset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetDataAsset.go.html to see an example of how to use GetDataAssetRequest.
type GetDataAssetRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Specifies the fields to return in a data asset response.
Fields []GetDataAssetFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetDataAssetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDataAssetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDataAssetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDataAssetRequest) String() string
func (request GetDataAssetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDataAssetResponse wrapper for the GetDataAsset operation
type GetDataAssetResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataAsset instance
DataAsset `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetDataAssetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDataAssetResponse) String() string
GetDataAssetTagFieldsEnum Enum with underlying type: string
type GetDataAssetTagFieldsEnum string
Set of constants representing the allowable values for GetDataAssetTagFieldsEnum
const (
GetDataAssetTagFieldsKey GetDataAssetTagFieldsEnum = "key"
GetDataAssetTagFieldsName GetDataAssetTagFieldsEnum = "name"
GetDataAssetTagFieldsTermkey GetDataAssetTagFieldsEnum = "termKey"
GetDataAssetTagFieldsTermpath GetDataAssetTagFieldsEnum = "termPath"
GetDataAssetTagFieldsTermdescription GetDataAssetTagFieldsEnum = "termDescription"
GetDataAssetTagFieldsLifecyclestate GetDataAssetTagFieldsEnum = "lifecycleState"
GetDataAssetTagFieldsTimecreated GetDataAssetTagFieldsEnum = "timeCreated"
GetDataAssetTagFieldsCreatedbyid GetDataAssetTagFieldsEnum = "createdById"
GetDataAssetTagFieldsUri GetDataAssetTagFieldsEnum = "uri"
GetDataAssetTagFieldsDataassetkey GetDataAssetTagFieldsEnum = "dataAssetKey"
)
func GetGetDataAssetTagFieldsEnumValues() []GetDataAssetTagFieldsEnum
GetGetDataAssetTagFieldsEnumValues Enumerates the set of values for GetDataAssetTagFieldsEnum
func GetMappingGetDataAssetTagFieldsEnum(val string) (GetDataAssetTagFieldsEnum, bool)
GetMappingGetDataAssetTagFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetDataAssetTagRequest wrapper for the GetDataAssetTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetDataAssetTag.go.html to see an example of how to use GetDataAssetTagRequest.
type GetDataAssetTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// Specifies the fields to return in a data asset tag response.
Fields []GetDataAssetTagFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetDataAssetTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDataAssetTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDataAssetTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDataAssetTagRequest) String() string
func (request GetDataAssetTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDataAssetTagResponse wrapper for the GetDataAssetTag operation
type GetDataAssetTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataAssetTag instance
DataAssetTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetDataAssetTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDataAssetTagResponse) String() string
GetEntityFieldsEnum Enum with underlying type: string
type GetEntityFieldsEnum string
Set of constants representing the allowable values for GetEntityFieldsEnum
const (
GetEntityFieldsKey GetEntityFieldsEnum = "key"
GetEntityFieldsDisplayname GetEntityFieldsEnum = "displayName"
GetEntityFieldsDescription GetEntityFieldsEnum = "description"
GetEntityFieldsDataassetkey GetEntityFieldsEnum = "dataAssetKey"
GetEntityFieldsTimecreated GetEntityFieldsEnum = "timeCreated"
GetEntityFieldsTimeupdated GetEntityFieldsEnum = "timeUpdated"
GetEntityFieldsCreatedbyid GetEntityFieldsEnum = "createdById"
GetEntityFieldsUpdatedbyid GetEntityFieldsEnum = "updatedById"
GetEntityFieldsLifecyclestate GetEntityFieldsEnum = "lifecycleState"
GetEntityFieldsExternalkey GetEntityFieldsEnum = "externalKey"
GetEntityFieldsTimeexternal GetEntityFieldsEnum = "timeExternal"
GetEntityFieldsTimestatusupdated GetEntityFieldsEnum = "timeStatusUpdated"
GetEntityFieldsIslogical GetEntityFieldsEnum = "isLogical"
GetEntityFieldsIspartition GetEntityFieldsEnum = "isPartition"
GetEntityFieldsFolderkey GetEntityFieldsEnum = "folderKey"
GetEntityFieldsFoldername GetEntityFieldsEnum = "folderName"
GetEntityFieldsTypekey GetEntityFieldsEnum = "typeKey"
GetEntityFieldsPath GetEntityFieldsEnum = "path"
GetEntityFieldsHarveststatus GetEntityFieldsEnum = "harvestStatus"
GetEntityFieldsLastjobkey GetEntityFieldsEnum = "lastJobKey"
GetEntityFieldsUri GetEntityFieldsEnum = "uri"
GetEntityFieldsProperties GetEntityFieldsEnum = "properties"
)
func GetGetEntityFieldsEnumValues() []GetEntityFieldsEnum
GetGetEntityFieldsEnumValues Enumerates the set of values for GetEntityFieldsEnum
func GetMappingGetEntityFieldsEnum(val string) (GetEntityFieldsEnum, bool)
GetMappingGetEntityFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetEntityRequest wrapper for the GetEntity operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetEntity.go.html to see an example of how to use GetEntityRequest.
type GetEntityRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Indicates whether the list of objects and their relationships to this object will be provided in the response.
IsIncludeObjectRelationships *bool `mandatory:"false" contributesTo:"query" name:"isIncludeObjectRelationships"`
// Specifies the fields to return in an entity response.
Fields []GetEntityFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetEntityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEntityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEntityRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEntityRequest) String() string
func (request GetEntityRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetEntityResponse wrapper for the GetEntity operation
type GetEntityResponse struct {
// The underlying http response
RawResponse *http.Response
// The Entity instance
Entity `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetEntityResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEntityResponse) String() string
GetEntityTagFieldsEnum Enum with underlying type: string
type GetEntityTagFieldsEnum string
Set of constants representing the allowable values for GetEntityTagFieldsEnum
const (
GetEntityTagFieldsKey GetEntityTagFieldsEnum = "key"
GetEntityTagFieldsName GetEntityTagFieldsEnum = "name"
GetEntityTagFieldsTermkey GetEntityTagFieldsEnum = "termKey"
GetEntityTagFieldsTermpath GetEntityTagFieldsEnum = "termPath"
GetEntityTagFieldsTermdescription GetEntityTagFieldsEnum = "termDescription"
GetEntityTagFieldsLifecyclestate GetEntityTagFieldsEnum = "lifecycleState"
GetEntityTagFieldsTimecreated GetEntityTagFieldsEnum = "timeCreated"
GetEntityTagFieldsCreatedbyid GetEntityTagFieldsEnum = "createdById"
GetEntityTagFieldsUri GetEntityTagFieldsEnum = "uri"
GetEntityTagFieldsEntitykey GetEntityTagFieldsEnum = "entityKey"
)
func GetGetEntityTagFieldsEnumValues() []GetEntityTagFieldsEnum
GetGetEntityTagFieldsEnumValues Enumerates the set of values for GetEntityTagFieldsEnum
func GetMappingGetEntityTagFieldsEnum(val string) (GetEntityTagFieldsEnum, bool)
GetMappingGetEntityTagFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetEntityTagRequest wrapper for the GetEntityTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetEntityTag.go.html to see an example of how to use GetEntityTagRequest.
type GetEntityTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// Specifies the fields to return in an entity tag response.
Fields []GetEntityTagFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetEntityTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEntityTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEntityTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEntityTagRequest) String() string
func (request GetEntityTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetEntityTagResponse wrapper for the GetEntityTag operation
type GetEntityTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The EntityTag instance
EntityTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetEntityTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEntityTagResponse) String() string
GetFolderFieldsEnum Enum with underlying type: string
type GetFolderFieldsEnum string
Set of constants representing the allowable values for GetFolderFieldsEnum
const (
GetFolderFieldsKey GetFolderFieldsEnum = "key"
GetFolderFieldsDisplayname GetFolderFieldsEnum = "displayName"
GetFolderFieldsDescription GetFolderFieldsEnum = "description"
GetFolderFieldsParentfolderkey GetFolderFieldsEnum = "parentFolderKey"
GetFolderFieldsPath GetFolderFieldsEnum = "path"
GetFolderFieldsDataassetkey GetFolderFieldsEnum = "dataAssetKey"
GetFolderFieldsProperties GetFolderFieldsEnum = "properties"
GetFolderFieldsExternalkey GetFolderFieldsEnum = "externalKey"
GetFolderFieldsTimecreated GetFolderFieldsEnum = "timeCreated"
GetFolderFieldsTimeupdated GetFolderFieldsEnum = "timeUpdated"
GetFolderFieldsCreatedbyid GetFolderFieldsEnum = "createdById"
GetFolderFieldsUpdatedbyid GetFolderFieldsEnum = "updatedById"
GetFolderFieldsTimeexternal GetFolderFieldsEnum = "timeExternal"
GetFolderFieldsLifecyclestate GetFolderFieldsEnum = "lifecycleState"
GetFolderFieldsHarveststatus GetFolderFieldsEnum = "harvestStatus"
GetFolderFieldsLastjobkey GetFolderFieldsEnum = "lastJobKey"
GetFolderFieldsUri GetFolderFieldsEnum = "uri"
)
func GetGetFolderFieldsEnumValues() []GetFolderFieldsEnum
GetGetFolderFieldsEnumValues Enumerates the set of values for GetFolderFieldsEnum
func GetMappingGetFolderFieldsEnum(val string) (GetFolderFieldsEnum, bool)
GetMappingGetFolderFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetFolderRequest wrapper for the GetFolder operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetFolder.go.html to see an example of how to use GetFolderRequest.
type GetFolderRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique folder key.
FolderKey *string `mandatory:"true" contributesTo:"path" name:"folderKey"`
// Indicates whether the list of objects and their relationships to this object will be provided in the response.
IsIncludeObjectRelationships *bool `mandatory:"false" contributesTo:"query" name:"isIncludeObjectRelationships"`
// Specifies the fields to return in a folder response.
Fields []GetFolderFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetFolderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetFolderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetFolderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetFolderRequest) String() string
func (request GetFolderRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetFolderResponse wrapper for the GetFolder operation
type GetFolderResponse struct {
// The underlying http response
RawResponse *http.Response
// The Folder instance
Folder `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetFolderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetFolderResponse) String() string
GetFolderTagFieldsEnum Enum with underlying type: string
type GetFolderTagFieldsEnum string
Set of constants representing the allowable values for GetFolderTagFieldsEnum
const (
GetFolderTagFieldsKey GetFolderTagFieldsEnum = "key"
GetFolderTagFieldsName GetFolderTagFieldsEnum = "name"
GetFolderTagFieldsTermkey GetFolderTagFieldsEnum = "termKey"
GetFolderTagFieldsTermpath GetFolderTagFieldsEnum = "termPath"
GetFolderTagFieldsTermdescription GetFolderTagFieldsEnum = "termDescription"
GetFolderTagFieldsLifecyclestate GetFolderTagFieldsEnum = "lifecycleState"
GetFolderTagFieldsTimecreated GetFolderTagFieldsEnum = "timeCreated"
GetFolderTagFieldsCreatedbyid GetFolderTagFieldsEnum = "createdById"
GetFolderTagFieldsUri GetFolderTagFieldsEnum = "uri"
GetFolderTagFieldsFolderkey GetFolderTagFieldsEnum = "folderKey"
)
func GetGetFolderTagFieldsEnumValues() []GetFolderTagFieldsEnum
GetGetFolderTagFieldsEnumValues Enumerates the set of values for GetFolderTagFieldsEnum
func GetMappingGetFolderTagFieldsEnum(val string) (GetFolderTagFieldsEnum, bool)
GetMappingGetFolderTagFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetFolderTagRequest wrapper for the GetFolderTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetFolderTag.go.html to see an example of how to use GetFolderTagRequest.
type GetFolderTagRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique folder key.
FolderKey *string `mandatory:"true" contributesTo:"path" name:"folderKey"`
// Unique tag key.
TagKey *string `mandatory:"true" contributesTo:"path" name:"tagKey"`
// Specifies the fields to return in a folder tag response.
Fields []GetFolderTagFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetFolderTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetFolderTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetFolderTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetFolderTagRequest) String() string
func (request GetFolderTagRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetFolderTagResponse wrapper for the GetFolderTag operation
type GetFolderTagResponse struct {
// The underlying http response
RawResponse *http.Response
// The FolderTag instance
FolderTag `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetFolderTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetFolderTagResponse) String() string
GetGlossaryFieldsEnum Enum with underlying type: string
type GetGlossaryFieldsEnum string
Set of constants representing the allowable values for GetGlossaryFieldsEnum
const (
GetGlossaryFieldsKey GetGlossaryFieldsEnum = "key"
GetGlossaryFieldsDisplayname GetGlossaryFieldsEnum = "displayName"
GetGlossaryFieldsDescription GetGlossaryFieldsEnum = "description"
GetGlossaryFieldsCatalogid GetGlossaryFieldsEnum = "catalogId"
GetGlossaryFieldsLifecyclestate GetGlossaryFieldsEnum = "lifecycleState"
GetGlossaryFieldsTimecreated GetGlossaryFieldsEnum = "timeCreated"
GetGlossaryFieldsTimeupdated GetGlossaryFieldsEnum = "timeUpdated"
GetGlossaryFieldsCreatedbyid GetGlossaryFieldsEnum = "createdById"
GetGlossaryFieldsUpdatedbyid GetGlossaryFieldsEnum = "updatedById"
GetGlossaryFieldsOwner GetGlossaryFieldsEnum = "owner"
GetGlossaryFieldsWorkflowstatus GetGlossaryFieldsEnum = "workflowStatus"
GetGlossaryFieldsUri GetGlossaryFieldsEnum = "uri"
)
func GetGetGlossaryFieldsEnumValues() []GetGlossaryFieldsEnum
GetGetGlossaryFieldsEnumValues Enumerates the set of values for GetGlossaryFieldsEnum
func GetMappingGetGlossaryFieldsEnum(val string) (GetGlossaryFieldsEnum, bool)
GetMappingGetGlossaryFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetGlossaryRequest wrapper for the GetGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetGlossary.go.html to see an example of how to use GetGlossaryRequest.
type GetGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Specifies the fields to return in a glossary response.
Fields []GetGlossaryFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGlossaryRequest) String() string
func (request GetGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetGlossaryResponse wrapper for the GetGlossary operation
type GetGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// The Glossary instance
Glossary `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGlossaryResponse) String() string
GetJobDefinitionFieldsEnum Enum with underlying type: string
type GetJobDefinitionFieldsEnum string
Set of constants representing the allowable values for GetJobDefinitionFieldsEnum
const (
GetJobDefinitionFieldsKey GetJobDefinitionFieldsEnum = "key"
GetJobDefinitionFieldsDisplayname GetJobDefinitionFieldsEnum = "displayName"
GetJobDefinitionFieldsDescription GetJobDefinitionFieldsEnum = "description"
GetJobDefinitionFieldsCatalogid GetJobDefinitionFieldsEnum = "catalogId"
GetJobDefinitionFieldsJobtype GetJobDefinitionFieldsEnum = "jobType"
GetJobDefinitionFieldsIsincremental GetJobDefinitionFieldsEnum = "isIncremental"
GetJobDefinitionFieldsDataassetkey GetJobDefinitionFieldsEnum = "dataAssetKey"
GetJobDefinitionFieldsConnectionkey GetJobDefinitionFieldsEnum = "connectionKey"
GetJobDefinitionFieldsInternalversion GetJobDefinitionFieldsEnum = "internalVersion"
GetJobDefinitionFieldsLifecyclestate GetJobDefinitionFieldsEnum = "lifecycleState"
GetJobDefinitionFieldsTimecreated GetJobDefinitionFieldsEnum = "timeCreated"
GetJobDefinitionFieldsTimeupdated GetJobDefinitionFieldsEnum = "timeUpdated"
GetJobDefinitionFieldsCreatedbyid GetJobDefinitionFieldsEnum = "createdById"
GetJobDefinitionFieldsUpdatedbyid GetJobDefinitionFieldsEnum = "updatedById"
GetJobDefinitionFieldsUri GetJobDefinitionFieldsEnum = "uri"
GetJobDefinitionFieldsIssampledataextracted GetJobDefinitionFieldsEnum = "isSampleDataExtracted"
GetJobDefinitionFieldsSampledatasizeinmbs GetJobDefinitionFieldsEnum = "sampleDataSizeInMBs"
GetJobDefinitionFieldsTimelatestexecutionstarted GetJobDefinitionFieldsEnum = "timeLatestExecutionStarted"
GetJobDefinitionFieldsTimelatestexecutionended GetJobDefinitionFieldsEnum = "timeLatestExecutionEnded"
GetJobDefinitionFieldsJobexecutionstate GetJobDefinitionFieldsEnum = "jobExecutionState"
GetJobDefinitionFieldsScheduletype GetJobDefinitionFieldsEnum = "scheduleType"
GetJobDefinitionFieldsProperties GetJobDefinitionFieldsEnum = "properties"
)
func GetGetJobDefinitionFieldsEnumValues() []GetJobDefinitionFieldsEnum
GetGetJobDefinitionFieldsEnumValues Enumerates the set of values for GetJobDefinitionFieldsEnum
func GetMappingGetJobDefinitionFieldsEnum(val string) (GetJobDefinitionFieldsEnum, bool)
GetMappingGetJobDefinitionFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetJobDefinitionRequest wrapper for the GetJobDefinition operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobDefinition.go.html to see an example of how to use GetJobDefinitionRequest.
type GetJobDefinitionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job definition key.
JobDefinitionKey *string `mandatory:"true" contributesTo:"path" name:"jobDefinitionKey"`
// Specifies the fields to return in a job definition response.
Fields []GetJobDefinitionFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetJobDefinitionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetJobDefinitionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetJobDefinitionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetJobDefinitionRequest) String() string
func (request GetJobDefinitionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetJobDefinitionResponse wrapper for the GetJobDefinition operation
type GetJobDefinitionResponse struct {
// The underlying http response
RawResponse *http.Response
// The JobDefinition instance
JobDefinition `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetJobDefinitionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetJobDefinitionResponse) String() string
GetJobExecutionFieldsEnum Enum with underlying type: string
type GetJobExecutionFieldsEnum string
Set of constants representing the allowable values for GetJobExecutionFieldsEnum
const (
GetJobExecutionFieldsKey GetJobExecutionFieldsEnum = "key"
GetJobExecutionFieldsJobkey GetJobExecutionFieldsEnum = "jobKey"
GetJobExecutionFieldsJobtype GetJobExecutionFieldsEnum = "jobType"
GetJobExecutionFieldsSubtype GetJobExecutionFieldsEnum = "subType"
GetJobExecutionFieldsParentkey GetJobExecutionFieldsEnum = "parentKey"
GetJobExecutionFieldsScheduleinstancekey GetJobExecutionFieldsEnum = "scheduleInstanceKey"
GetJobExecutionFieldsLifecyclestate GetJobExecutionFieldsEnum = "lifecycleState"
GetJobExecutionFieldsTimecreated GetJobExecutionFieldsEnum = "timeCreated"
GetJobExecutionFieldsTimestarted GetJobExecutionFieldsEnum = "timeStarted"
GetJobExecutionFieldsTimeended GetJobExecutionFieldsEnum = "timeEnded"
GetJobExecutionFieldsErrorcode GetJobExecutionFieldsEnum = "errorCode"
GetJobExecutionFieldsErrormessage GetJobExecutionFieldsEnum = "errorMessage"
GetJobExecutionFieldsProcesskey GetJobExecutionFieldsEnum = "processKey"
GetJobExecutionFieldsExternalurl GetJobExecutionFieldsEnum = "externalUrl"
GetJobExecutionFieldsEventkey GetJobExecutionFieldsEnum = "eventKey"
GetJobExecutionFieldsDataentitykey GetJobExecutionFieldsEnum = "dataEntityKey"
GetJobExecutionFieldsCreatedbyid GetJobExecutionFieldsEnum = "createdById"
GetJobExecutionFieldsUpdatedbyid GetJobExecutionFieldsEnum = "updatedById"
GetJobExecutionFieldsProperties GetJobExecutionFieldsEnum = "properties"
GetJobExecutionFieldsUri GetJobExecutionFieldsEnum = "uri"
)
func GetGetJobExecutionFieldsEnumValues() []GetJobExecutionFieldsEnum
GetGetJobExecutionFieldsEnumValues Enumerates the set of values for GetJobExecutionFieldsEnum
func GetMappingGetJobExecutionFieldsEnum(val string) (GetJobExecutionFieldsEnum, bool)
GetMappingGetJobExecutionFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetJobExecutionRequest wrapper for the GetJobExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobExecution.go.html to see an example of how to use GetJobExecutionRequest.
type GetJobExecutionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// The key of the job execution.
JobExecutionKey *string `mandatory:"true" contributesTo:"path" name:"jobExecutionKey"`
// Specifies the fields to return in a job execution response.
Fields []GetJobExecutionFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetJobExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetJobExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetJobExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetJobExecutionRequest) String() string
func (request GetJobExecutionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetJobExecutionResponse wrapper for the GetJobExecution operation
type GetJobExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// The JobExecution instance
JobExecution `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetJobExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetJobExecutionResponse) String() string
GetJobFieldsEnum Enum with underlying type: string
type GetJobFieldsEnum string
Set of constants representing the allowable values for GetJobFieldsEnum
const (
GetJobFieldsKey GetJobFieldsEnum = "key"
GetJobFieldsDisplayname GetJobFieldsEnum = "displayName"
GetJobFieldsDescription GetJobFieldsEnum = "description"
GetJobFieldsCatalogid GetJobFieldsEnum = "catalogId"
GetJobFieldsLifecyclestate GetJobFieldsEnum = "lifecycleState"
GetJobFieldsTimecreated GetJobFieldsEnum = "timeCreated"
GetJobFieldsTimeupdated GetJobFieldsEnum = "timeUpdated"
GetJobFieldsJobtype GetJobFieldsEnum = "jobType"
GetJobFieldsSchedulecronexpression GetJobFieldsEnum = "scheduleCronExpression"
GetJobFieldsTimeschedulebegin GetJobFieldsEnum = "timeScheduleBegin"
GetJobFieldsTimescheduleend GetJobFieldsEnum = "timeScheduleEnd"
GetJobFieldsScheduletype GetJobFieldsEnum = "scheduleType"
GetJobFieldsConnectionkey GetJobFieldsEnum = "connectionKey"
GetJobFieldsJobdefinitionkey GetJobFieldsEnum = "jobDefinitionKey"
GetJobFieldsInternalversion GetJobFieldsEnum = "internalVersion"
GetJobFieldsExecutioncount GetJobFieldsEnum = "executionCount"
GetJobFieldsTimeoflatestexecution GetJobFieldsEnum = "timeOfLatestExecution"
GetJobFieldsExecutions GetJobFieldsEnum = "executions"
GetJobFieldsCreatedbyid GetJobFieldsEnum = "createdById"
GetJobFieldsUpdatedbyid GetJobFieldsEnum = "updatedById"
GetJobFieldsUri GetJobFieldsEnum = "uri"
GetJobFieldsJobdefinitionname GetJobFieldsEnum = "jobDefinitionName"
GetJobFieldsErrorcode GetJobFieldsEnum = "errorCode"
GetJobFieldsErrormessage GetJobFieldsEnum = "errorMessage"
)
func GetGetJobFieldsEnumValues() []GetJobFieldsEnum
GetGetJobFieldsEnumValues Enumerates the set of values for GetJobFieldsEnum
func GetMappingGetJobFieldsEnum(val string) (GetJobFieldsEnum, bool)
GetMappingGetJobFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetJobLogFieldsEnum Enum with underlying type: string
type GetJobLogFieldsEnum string
Set of constants representing the allowable values for GetJobLogFieldsEnum
const (
GetJobLogFieldsKey GetJobLogFieldsEnum = "key"
GetJobLogFieldsJobexecutionkey GetJobLogFieldsEnum = "jobExecutionKey"
GetJobLogFieldsCreatedbyid GetJobLogFieldsEnum = "createdById"
GetJobLogFieldsUpdatedbyid GetJobLogFieldsEnum = "updatedById"
GetJobLogFieldsTimeupdated GetJobLogFieldsEnum = "timeUpdated"
GetJobLogFieldsTimecreated GetJobLogFieldsEnum = "timeCreated"
GetJobLogFieldsSeverity GetJobLogFieldsEnum = "severity"
GetJobLogFieldsLogmessage GetJobLogFieldsEnum = "logMessage"
GetJobLogFieldsUri GetJobLogFieldsEnum = "uri"
)
func GetGetJobLogFieldsEnumValues() []GetJobLogFieldsEnum
GetGetJobLogFieldsEnumValues Enumerates the set of values for GetJobLogFieldsEnum
func GetMappingGetJobLogFieldsEnum(val string) (GetJobLogFieldsEnum, bool)
GetMappingGetJobLogFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetJobLogRequest wrapper for the GetJobLog operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobLog.go.html to see an example of how to use GetJobLogRequest.
type GetJobLogRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// The key of the job execution.
JobExecutionKey *string `mandatory:"true" contributesTo:"path" name:"jobExecutionKey"`
// Unique job log key.
JobLogKey *string `mandatory:"true" contributesTo:"path" name:"jobLogKey"`
// Specifies the fields to return in a job log response.
Fields []GetJobLogFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetJobLogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetJobLogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetJobLogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetJobLogRequest) String() string
func (request GetJobLogRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetJobLogResponse wrapper for the GetJobLog operation
type GetJobLogResponse struct {
// The underlying http response
RawResponse *http.Response
// The JobLog instance
JobLog `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetJobLogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetJobLogResponse) String() string
GetJobMetricsFieldsEnum Enum with underlying type: string
type GetJobMetricsFieldsEnum string
Set of constants representing the allowable values for GetJobMetricsFieldsEnum
const (
GetJobMetricsFieldsKey GetJobMetricsFieldsEnum = "key"
GetJobMetricsFieldsDescription GetJobMetricsFieldsEnum = "description"
GetJobMetricsFieldsDisplayname GetJobMetricsFieldsEnum = "displayName"
GetJobMetricsFieldsTimeinserted GetJobMetricsFieldsEnum = "timeInserted"
GetJobMetricsFieldsCategory GetJobMetricsFieldsEnum = "category"
GetJobMetricsFieldsSubcategory GetJobMetricsFieldsEnum = "subCategory"
GetJobMetricsFieldsUnit GetJobMetricsFieldsEnum = "unit"
GetJobMetricsFieldsValue GetJobMetricsFieldsEnum = "value"
GetJobMetricsFieldsBatchkey GetJobMetricsFieldsEnum = "batchKey"
GetJobMetricsFieldsJobexecutionkey GetJobMetricsFieldsEnum = "jobExecutionKey"
GetJobMetricsFieldsCreatedbyid GetJobMetricsFieldsEnum = "createdById"
GetJobMetricsFieldsUpdatedbyid GetJobMetricsFieldsEnum = "updatedById"
GetJobMetricsFieldsTimeupdated GetJobMetricsFieldsEnum = "timeUpdated"
GetJobMetricsFieldsTimecreated GetJobMetricsFieldsEnum = "timeCreated"
GetJobMetricsFieldsUri GetJobMetricsFieldsEnum = "uri"
)
func GetGetJobMetricsFieldsEnumValues() []GetJobMetricsFieldsEnum
GetGetJobMetricsFieldsEnumValues Enumerates the set of values for GetJobMetricsFieldsEnum
func GetMappingGetJobMetricsFieldsEnum(val string) (GetJobMetricsFieldsEnum, bool)
GetMappingGetJobMetricsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetJobMetricsRequest wrapper for the GetJobMetrics operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJobMetrics.go.html to see an example of how to use GetJobMetricsRequest.
type GetJobMetricsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// The key of the job execution.
JobExecutionKey *string `mandatory:"true" contributesTo:"path" name:"jobExecutionKey"`
// Unique job metrics key.
JobMetricsKey *string `mandatory:"true" contributesTo:"path" name:"jobMetricsKey"`
// Specifies the fields to return in a job metric response.
Fields []GetJobMetricsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetJobMetricsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetJobMetricsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetJobMetricsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetJobMetricsRequest) String() string
func (request GetJobMetricsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetJobMetricsResponse wrapper for the GetJobMetrics operation
type GetJobMetricsResponse struct {
// The underlying http response
RawResponse *http.Response
// The JobMetric instance
JobMetric `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetJobMetricsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetJobMetricsResponse) String() string
GetJobRequest wrapper for the GetJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetJob.go.html to see an example of how to use GetJobRequest.
type GetJobRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// Specifies the fields to return in a job response.
Fields []GetJobFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetJobRequest) String() string
func (request GetJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetJobResponse wrapper for the GetJob operation
type GetJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The Job instance
Job `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetJobResponse) String() string
GetMetastoreRequest wrapper for the GetMetastore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetMetastore.go.html to see an example of how to use GetMetastoreRequest.
type GetMetastoreRequest struct {
// The metastore's OCID.
MetastoreId *string `mandatory:"true" contributesTo:"path" name:"metastoreId"`
// 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 GetMetastoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetMetastoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetMetastoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetMetastoreRequest) String() string
func (request GetMetastoreRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetMetastoreResponse wrapper for the GetMetastore operation
type GetMetastoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The Metastore instance
Metastore `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetMetastoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetMetastoreResponse) String() string
GetNamespaceFieldsEnum Enum with underlying type: string
type GetNamespaceFieldsEnum string
Set of constants representing the allowable values for GetNamespaceFieldsEnum
const (
GetNamespaceFieldsKey GetNamespaceFieldsEnum = "key"
GetNamespaceFieldsDisplayname GetNamespaceFieldsEnum = "displayName"
GetNamespaceFieldsDescription GetNamespaceFieldsEnum = "description"
GetNamespaceFieldsLifecyclestate GetNamespaceFieldsEnum = "lifecycleState"
GetNamespaceFieldsTimecreated GetNamespaceFieldsEnum = "timeCreated"
GetNamespaceFieldsTimeupdated GetNamespaceFieldsEnum = "timeUpdated"
GetNamespaceFieldsCreatedbyid GetNamespaceFieldsEnum = "createdById"
GetNamespaceFieldsUpdatedbyid GetNamespaceFieldsEnum = "updatedById"
GetNamespaceFieldsProperties GetNamespaceFieldsEnum = "properties"
)
func GetGetNamespaceFieldsEnumValues() []GetNamespaceFieldsEnum
GetGetNamespaceFieldsEnumValues Enumerates the set of values for GetNamespaceFieldsEnum
func GetMappingGetNamespaceFieldsEnum(val string) (GetNamespaceFieldsEnum, bool)
GetMappingGetNamespaceFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetNamespaceRequest wrapper for the GetNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetNamespace.go.html to see an example of how to use GetNamespaceRequest.
type GetNamespaceRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// Specifies the fields to return in a namespace response.
Fields []GetNamespaceFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNamespaceRequest) String() string
func (request GetNamespaceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetNamespaceResponse wrapper for the GetNamespace operation
type GetNamespaceResponse struct {
// The underlying http response
RawResponse *http.Response
// The Namespace instance
Namespace `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNamespaceResponse) String() string
GetPatternFieldsEnum Enum with underlying type: string
type GetPatternFieldsEnum string
Set of constants representing the allowable values for GetPatternFieldsEnum
const (
GetPatternFieldsKey GetPatternFieldsEnum = "key"
GetPatternFieldsDisplayname GetPatternFieldsEnum = "displayName"
GetPatternFieldsDescription GetPatternFieldsEnum = "description"
GetPatternFieldsCatalogid GetPatternFieldsEnum = "catalogId"
GetPatternFieldsExpression GetPatternFieldsEnum = "expression"
GetPatternFieldsLifecyclestate GetPatternFieldsEnum = "lifecycleState"
GetPatternFieldsTimecreated GetPatternFieldsEnum = "timeCreated"
GetPatternFieldsTimeupdated GetPatternFieldsEnum = "timeUpdated"
GetPatternFieldsCreatedbyid GetPatternFieldsEnum = "createdById"
GetPatternFieldsUpdatedbyid GetPatternFieldsEnum = "updatedById"
GetPatternFieldsProperties GetPatternFieldsEnum = "properties"
)
func GetGetPatternFieldsEnumValues() []GetPatternFieldsEnum
GetGetPatternFieldsEnumValues Enumerates the set of values for GetPatternFieldsEnum
func GetMappingGetPatternFieldsEnum(val string) (GetPatternFieldsEnum, bool)
GetMappingGetPatternFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetPatternRequest wrapper for the GetPattern operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetPattern.go.html to see an example of how to use GetPatternRequest.
type GetPatternRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique pattern key.
PatternKey *string `mandatory:"true" contributesTo:"path" name:"patternKey"`
// Specifies the fields to return in a pattern response.
Fields []GetPatternFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetPatternRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPatternRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPatternRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPatternRequest) String() string
func (request GetPatternRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPatternResponse wrapper for the GetPattern operation
type GetPatternResponse struct {
// The underlying http response
RawResponse *http.Response
// The Pattern instance
Pattern `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetPatternResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPatternResponse) String() string
GetTermFieldsEnum Enum with underlying type: string
type GetTermFieldsEnum string
Set of constants representing the allowable values for GetTermFieldsEnum
const (
GetTermFieldsKey GetTermFieldsEnum = "key"
GetTermFieldsDisplayname GetTermFieldsEnum = "displayName"
GetTermFieldsDescription GetTermFieldsEnum = "description"
GetTermFieldsGlossarykey GetTermFieldsEnum = "glossaryKey"
GetTermFieldsParenttermkey GetTermFieldsEnum = "parentTermKey"
GetTermFieldsIsallowedtohavechildterms GetTermFieldsEnum = "isAllowedToHaveChildTerms"
GetTermFieldsPath GetTermFieldsEnum = "path"
GetTermFieldsLifecyclestate GetTermFieldsEnum = "lifecycleState"
GetTermFieldsTimecreated GetTermFieldsEnum = "timeCreated"
GetTermFieldsTimeupdated GetTermFieldsEnum = "timeUpdated"
GetTermFieldsCreatedbyid GetTermFieldsEnum = "createdById"
GetTermFieldsUpdatedbyid GetTermFieldsEnum = "updatedById"
GetTermFieldsOwner GetTermFieldsEnum = "owner"
GetTermFieldsWorkflowstatus GetTermFieldsEnum = "workflowStatus"
GetTermFieldsUri GetTermFieldsEnum = "uri"
GetTermFieldsRelatedterms GetTermFieldsEnum = "relatedTerms"
GetTermFieldsAssociatedobjectcount GetTermFieldsEnum = "associatedObjectCount"
GetTermFieldsAssociatedobjects GetTermFieldsEnum = "associatedObjects"
)
func GetGetTermFieldsEnumValues() []GetTermFieldsEnum
GetGetTermFieldsEnumValues Enumerates the set of values for GetTermFieldsEnum
func GetMappingGetTermFieldsEnum(val string) (GetTermFieldsEnum, bool)
GetMappingGetTermFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetTermRelationshipFieldsEnum Enum with underlying type: string
type GetTermRelationshipFieldsEnum string
Set of constants representing the allowable values for GetTermRelationshipFieldsEnum
const (
GetTermRelationshipFieldsKey GetTermRelationshipFieldsEnum = "key"
GetTermRelationshipFieldsDisplayname GetTermRelationshipFieldsEnum = "displayName"
GetTermRelationshipFieldsDescription GetTermRelationshipFieldsEnum = "description"
GetTermRelationshipFieldsRelatedtermkey GetTermRelationshipFieldsEnum = "relatedTermKey"
GetTermRelationshipFieldsRelatedtermdisplayname GetTermRelationshipFieldsEnum = "relatedTermDisplayName"
GetTermRelationshipFieldsParenttermkey GetTermRelationshipFieldsEnum = "parentTermKey"
GetTermRelationshipFieldsParenttermdisplayname GetTermRelationshipFieldsEnum = "parentTermDisplayName"
GetTermRelationshipFieldsLifecyclestate GetTermRelationshipFieldsEnum = "lifecycleState"
GetTermRelationshipFieldsTimecreated GetTermRelationshipFieldsEnum = "timeCreated"
GetTermRelationshipFieldsUri GetTermRelationshipFieldsEnum = "uri"
)
func GetGetTermRelationshipFieldsEnumValues() []GetTermRelationshipFieldsEnum
GetGetTermRelationshipFieldsEnumValues Enumerates the set of values for GetTermRelationshipFieldsEnum
func GetMappingGetTermRelationshipFieldsEnum(val string) (GetTermRelationshipFieldsEnum, bool)
GetMappingGetTermRelationshipFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetTermRelationshipRequest wrapper for the GetTermRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetTermRelationship.go.html to see an example of how to use GetTermRelationshipRequest.
type GetTermRelationshipRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// Unique glossary term relationship key.
TermRelationshipKey *string `mandatory:"true" contributesTo:"path" name:"termRelationshipKey"`
// Specifies the fields to return in a term relationship response.
Fields []GetTermRelationshipFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetTermRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTermRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTermRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTermRelationshipRequest) String() string
func (request GetTermRelationshipRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTermRelationshipResponse wrapper for the GetTermRelationship operation
type GetTermRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// The TermRelationship instance
TermRelationship `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetTermRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTermRelationshipResponse) String() string
GetTermRequest wrapper for the GetTerm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetTerm.go.html to see an example of how to use GetTermRequest.
type GetTermRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// Specifies the fields to return in a term response.
Fields []GetTermFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetTermRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTermRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTermRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTermRequest) String() string
func (request GetTermRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTermResponse wrapper for the GetTerm operation
type GetTermResponse struct {
// The underlying http response
RawResponse *http.Response
// The Term instance
Term `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetTermResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTermResponse) String() string
GetTypeFieldsEnum Enum with underlying type: string
type GetTypeFieldsEnum string
Set of constants representing the allowable values for GetTypeFieldsEnum
const (
GetTypeFieldsKey GetTypeFieldsEnum = "key"
GetTypeFieldsDescription GetTypeFieldsEnum = "description"
GetTypeFieldsName GetTypeFieldsEnum = "name"
GetTypeFieldsCatalogid GetTypeFieldsEnum = "catalogId"
GetTypeFieldsProperties GetTypeFieldsEnum = "properties"
GetTypeFieldsIsinternal GetTypeFieldsEnum = "isInternal"
GetTypeFieldsIstag GetTypeFieldsEnum = "isTag"
GetTypeFieldsIsapproved GetTypeFieldsEnum = "isApproved"
GetTypeFieldsTypecategory GetTypeFieldsEnum = "typeCategory"
GetTypeFieldsExternaltypename GetTypeFieldsEnum = "externalTypeName"
GetTypeFieldsLifecyclestate GetTypeFieldsEnum = "lifecycleState"
GetTypeFieldsUri GetTypeFieldsEnum = "uri"
)
func GetGetTypeFieldsEnumValues() []GetTypeFieldsEnum
GetGetTypeFieldsEnumValues Enumerates the set of values for GetTypeFieldsEnum
func GetMappingGetTypeFieldsEnum(val string) (GetTypeFieldsEnum, bool)
GetMappingGetTypeFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetTypeRequest wrapper for the GetType operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetType.go.html to see an example of how to use GetTypeRequest.
type GetTypeRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique type key.
TypeKey *string `mandatory:"true" contributesTo:"path" name:"typeKey"`
// Specifies the fields to return in a type response.
Fields []GetTypeFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 GetTypeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTypeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTypeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTypeRequest) String() string
func (request GetTypeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTypeResponse wrapper for the GetType operation
type GetTypeResponse struct {
// The underlying http response
RawResponse *http.Response
// The ModelType instance
ModelType `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetTypeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTypeResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID 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"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
// A non-negative integer representing 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
Glossary Full glossary details. A glossary of business terms, such as 'Customer', 'Account', 'Contact' , 'Address', or 'Product', with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as 'taxonomies'. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data aatalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.
type Glossary struct {
// Unique glossary key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the glossary.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// The current state of the glossary.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the glossary was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the glossary. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created this metadata element.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated this metadata element.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// OCID of the user who is the owner of the glossary.
Owner *string `mandatory:"false" json:"owner"`
// Status of the approval process workflow for this business glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// The unique key of the job definition resource that was used in the Glossary import.
ImportJobDefinitionKey *string `mandatory:"false" json:"importJobDefinitionKey"`
// The unique key of the job policy for Glossary import.
ImportJobKey *string `mandatory:"false" json:"importJobKey"`
// The unique key of the parent job execution for which the log resource was created.
LatestImportJobExecutionKey *string `mandatory:"false" json:"latestImportJobExecutionKey"`
// Status of the latest glossary import job execution, such as running, paused, or completed.
// This may include additional information like time import started , import file size and % of completion
LatestImportJobExecutionStatus *string `mandatory:"false" json:"latestImportJobExecutionStatus"`
// URI to the tag instance in the API.
Uri *string `mandatory:"false" json:"uri"`
}
func (m Glossary) String() string
func (m Glossary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GlossaryCollection Results of a glossaries listing. Glossary is an organizing concept for business terms to provide a unified semantic model across disparate data assets.
type GlossaryCollection struct {
// Collection of glossaries.
Items []GlossarySummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m GlossaryCollection) String() string
func (m GlossaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GlossaryPermissionsSummary Permissions object for glosssaries.
type GlossaryPermissionsSummary struct {
// An array of permissions.
UserPermissions []string `mandatory:"false" json:"userPermissions"`
// The unique key of the parent glossary.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
}
func (m GlossaryPermissionsSummary) String() string
func (m GlossaryPermissionsSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GlossarySummary Summary of a glossary. A glossary of business terms, such as 'Customer', 'Account', 'Contact', 'Address', or 'Product', with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as 'taxonomies'. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data catalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.
type GlossarySummary struct {
// Unique glossary key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// The date and time the glossary was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Detailed description of the glossary.
Description *string `mandatory:"false" json:"description"`
// URI to the glossary instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Status of the approval process workflow for this business glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// State of the Glossary.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The unique key of the job definition resource that was used in the Glossary import.
ImportJobDefinitionKey *string `mandatory:"false" json:"importJobDefinitionKey"`
// The unique key of the job policy for Glossary import.
ImportJobKey *string `mandatory:"false" json:"importJobKey"`
// The unique key of the parent job execution for which the log resource was created.
LatestImportJobExecutionKey *string `mandatory:"false" json:"latestImportJobExecutionKey"`
// Status of the latest glossary import job execution, such as running, paused, or completed.
// This may include additional information like time import started , import file size and % of completion
LatestImportJobExecutionStatus *string `mandatory:"false" json:"latestImportJobExecutionStatus"`
}
func (m GlossarySummary) String() string
func (m GlossarySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GlossaryTreeElement Glossary tree element with child terms.
type GlossaryTreeElement struct {
// Unique term key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the term.
Description *string `mandatory:"false" json:"description"`
// Unique id of the parent glossary.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// URI to the term instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// This terms parent term key. Will be null if the term has no parent term.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// Indicates whether a term may contain child terms.
IsAllowedToHaveChildTerms *bool `mandatory:"false" json:"isAllowedToHaveChildTerms"`
// Absolute path of the term.
Path *string `mandatory:"false" json:"path"`
// The date and time the term was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Status of the approval process workflow for this business term in the glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// The number of objects tagged with this term.
AssociatedObjectCount *int `mandatory:"false" json:"associatedObjectCount"`
// State of the term.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// An array of child terms.
ChildTerms []GlossaryTreeElement `mandatory:"false" json:"childTerms"`
}
func (m GlossaryTreeElement) String() string
func (m GlossaryTreeElement) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HarvestStatusEnum Enum with underlying type: string
type HarvestStatusEnum string
Set of constants representing the allowable values for HarvestStatusEnum
const (
HarvestStatusComplete HarvestStatusEnum = "COMPLETE"
HarvestStatusError HarvestStatusEnum = "ERROR"
HarvestStatusInProgress HarvestStatusEnum = "IN_PROGRESS"
HarvestStatusDeferred HarvestStatusEnum = "DEFERRED"
)
func GetHarvestStatusEnumValues() []HarvestStatusEnum
GetHarvestStatusEnumValues Enumerates the set of values for HarvestStatusEnum
func GetMappingHarvestStatusEnum(val string) (HarvestStatusEnum, bool)
GetMappingHarvestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ImportConnectionDetails Import connection from the connection metadata and oracle wallet file.
type ImportConnectionDetails struct {
// The information used to import the connection.
ConnectionPayload []byte `mandatory:"true" json:"connectionPayload"`
ConnectionDetail *CreateConnectionDetails `mandatory:"false" json:"connectionDetail"`
}
func (m ImportConnectionDetails) String() string
func (m ImportConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportConnectionRequest wrapper for the ImportConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportConnection.go.html to see an example of how to use ImportConnectionRequest.
type ImportConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to create the connections through import.
ImportConnectionDetails `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 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ImportConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportConnectionRequest) String() string
func (request ImportConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportConnectionResponse wrapper for the ImportConnection operation
type ImportConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Connection instance
Connection `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response ImportConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportConnectionResponse) String() string
ImportDataAssetDetails Specifies the file contents to be imported.
type ImportDataAssetDetails struct {
// The file contents to be imported. File size not to exceed 10 MB.
ImportFileContents []byte `mandatory:"true" json:"importFileContents"`
}
func (m ImportDataAssetDetails) String() string
func (m ImportDataAssetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportDataAssetJobResult Information about a data asset import operation.
type ImportDataAssetJobResult struct {
// The unique key of the data asset on which import is triggered.
DataAssetKey *string `mandatory:"true" json:"dataAssetKey"`
// The unique key of the job definition resource that is used for the import.
ImportJobDefinitionKey *string `mandatory:"false" json:"importJobDefinitionKey"`
// The unique key of the job policy for the import.
ImportJobKey *string `mandatory:"false" json:"importJobKey"`
// The unique key of the parent job execution for which the log resource is created.
ImportJobExecutionKey *string `mandatory:"false" json:"importJobExecutionKey"`
// The status of the import job execution.
ImportJobExecutionStatus JobExecutionStateEnum `mandatory:"false" json:"importJobExecutionStatus,omitempty"`
}
func (m ImportDataAssetJobResult) String() string
func (m ImportDataAssetJobResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportDataAssetRequest wrapper for the ImportDataAsset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportDataAsset.go.html to see an example of how to use ImportDataAssetRequest.
type ImportDataAssetRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The file contents to be imported.
ImportDataAssetDetails `contributesTo:"body"`
// Type of import.
ImportType []DataAssetImportExportTypeFilterEnum `contributesTo:"query" name:"importType" omitEmpty:"true" collectionFormat:"multi"`
// Specify whether to ignore the missing values in the import file.
IsMissingValueIgnored *bool `mandatory:"false" contributesTo:"query" name:"isMissingValueIgnored"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ImportDataAssetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportDataAssetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportDataAssetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportDataAssetRequest) String() string
func (request ImportDataAssetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportDataAssetResponse wrapper for the ImportDataAsset operation
type ImportDataAssetResponse struct {
// The underlying http response
RawResponse *http.Response
// The ImportDataAssetJobResult instance
ImportDataAssetJobResult `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"`
}
func (response ImportDataAssetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportDataAssetResponse) String() string
ImportGlossaryDetails Import glossary from the contents of the glossary definition file.
type ImportGlossaryDetails struct {
// The file contents used for the import of glossary.
GlossaryFileContents []byte `mandatory:"false" json:"glossaryFileContents"`
}
func (m ImportGlossaryDetails) String() string
func (m ImportGlossaryDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportGlossaryRequest wrapper for the ImportGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportGlossary.go.html to see an example of how to use ImportGlossaryRequest.
type ImportGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// The file contents to import the glossary.
ImportGlossaryDetails `contributesTo:"body"`
// Specify if the relationship metadata is imported for the glossary.
IsRelationshipImported *bool `mandatory:"false" contributesTo:"query" name:"isRelationshipImported"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ImportGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportGlossaryRequest) String() string
func (request ImportGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportGlossaryResponse wrapper for the ImportGlossary operation
type ImportGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response ImportGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportGlossaryResponse) String() string
ImportLineageDetails Specifies the lineage contents to be imported.
type ImportLineageDetails struct {
// The payload used to import lineage.
LineagePayload []byte `mandatory:"true" json:"lineagePayload"`
}
func (m ImportLineageDetails) String() string
func (m ImportLineageDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportLineageJobResult Information about lineage import operation.
type ImportLineageJobResult struct {
// The unique key of the data asset on which import is triggered.
DataAssetKey *string `mandatory:"true" json:"dataAssetKey"`
// The unique key of the parent job execution for which the log resource is created.
ImportJobExecutionKey *string `mandatory:"true" json:"importJobExecutionKey"`
// The unique key of the job definition resource that is used for the import.
ImportJobDefinitionKey *string `mandatory:"false" json:"importJobDefinitionKey"`
// The unique key of the job for the import.
ImportJobKey *string `mandatory:"false" json:"importJobKey"`
// The state of the import job execution.
ImportJobExecutionStatus JobExecutionStateEnum `mandatory:"false" json:"importJobExecutionStatus,omitempty"`
}
func (m ImportLineageJobResult) String() string
func (m ImportLineageJobResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportLineageRequest wrapper for the ImportLineage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ImportLineage.go.html to see an example of how to use ImportLineageRequest.
type ImportLineageRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Details needed by the lineage import request.
ImportLineageDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ImportLineageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportLineageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportLineageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportLineageRequest) String() string
func (request ImportLineageRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportLineageResponse wrapper for the ImportLineage operation
type ImportLineageResponse struct {
// The underlying http response
RawResponse *http.Response
// The ImportLineageJobResult instance
ImportLineageJobResult `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"`
}
func (response ImportLineageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportLineageResponse) String() string
Job Details of a job. Jobs are scheduled instances of a job definition.
type Job struct {
// Unique key of the job resource.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the job.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// Lifecycle state for job.
LifecycleState JobLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the job was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time that this job was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Type of the job.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".
// The following subset of those is supported: @monthly, @weekly, @daily, @hourly.
// For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.
ScheduleCronExpression *string `mandatory:"false" json:"scheduleCronExpression"`
// Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleBegin *common.SDKTime `mandatory:"false" json:"timeScheduleBegin"`
// Date that the schedule should end from being operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleEnd *common.SDKTime `mandatory:"false" json:"timeScheduleEnd"`
// Type of job schedule that is inferred from the scheduling properties.
ScheduleType JobScheduleTypeEnum `mandatory:"false" json:"scheduleType,omitempty"`
// The key of the connection used by the job. This connection will override the default connection specified in
// the associated job definition. All executions will use this connection.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
// The unique key of the job definition resource that defined the scope of this job.
JobDefinitionKey *string `mandatory:"false" json:"jobDefinitionKey"`
// Internal version of the job resource.
InternalVersion *string `mandatory:"false" json:"internalVersion"`
// The total number of executions for this job schedule.
ExecutionCount *int `mandatory:"false" json:"executionCount"`
// The date and time of the most recent execution for this Job, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeOfLatestExecution *common.SDKTime `mandatory:"false" json:"timeOfLatestExecution"`
// OCID of the user who created this job.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated this job.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// The display name of the job definition resource that defined the scope of this job.
JobDefinitionName *string `mandatory:"false" json:"jobDefinitionName"`
// Unique key of the data asset to which this job applies, if the job involves a data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.
ErrorCode *string `mandatory:"false" json:"errorCode"`
// Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
// URI to the job instance in the API.
Uri *string `mandatory:"false" json:"uri"`
}
func (m Job) String() string
func (m Job) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobCollection Results of a jobs listing. Jobs are scheduled instances of a job definition.
type JobCollection struct {
// Collection of jobs.
Items []JobSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m JobCollection) String() string
func (m JobCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobDefinition Representation of a job definition resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.
type JobDefinition struct {
// Unique key of the job definition resource that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// Type of the job definition.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// Specifies if the job definition is incremental or full.
IsIncremental *bool `mandatory:"false" json:"isIncremental"`
// The key of the data asset for which the job is defined.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Detailed description of the job definition.
Description *string `mandatory:"false" json:"description"`
// The key of the default connection resource to be used for harvest, sampling, profiling jobs.
// This may be overridden in each job instance.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
// Version of the job definition object. Used internally but can be visible to users.
InternalVersion *string `mandatory:"false" json:"internalVersion"`
// Lifecycle state of the job definition.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the job definition was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the data asset. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created this job definition.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated this job definition.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// URI to the job definition instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Specify if sample data to be extracted as part of this harvest.
IsSampleDataExtracted *bool `mandatory:"false" json:"isSampleDataExtracted"`
// Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
SampleDataSizeInMBs *int `mandatory:"false" json:"sampleDataSizeInMBs"`
// Time that the latest job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeLatestExecutionStarted *common.SDKTime `mandatory:"false" json:"timeLatestExecutionStarted"`
// Time that the latest job execution ended or null if it hasn't yet completed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeLatestExecutionEnded *common.SDKTime `mandatory:"false" json:"timeLatestExecutionEnded"`
// Status of the latest job execution, such as running, paused, or completed.
JobExecutionState JobExecutionStateEnum `mandatory:"false" json:"jobExecutionState,omitempty"`
// Type of job schedule for the latest job executed.
ScheduleType JobScheduleTypeEnum `mandatory:"false" json:"scheduleType,omitempty"`
// A map of maps that contains the properties which are specific to the job type. Each job type
// definition may define it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// job definitions have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m JobDefinition) String() string
func (m JobDefinition) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobDefinitionCollection Results of a job definition listing. Job definitions are resources that describe the scope and type of jobs (eg: harvest, profiling, sampling) that are defined by users in the system.
type JobDefinitionCollection struct {
// Collection of job definitions.
Items []JobDefinitionSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m JobDefinitionCollection) String() string
func (m JobDefinitionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobDefinitionPermissionsSummary Permissions object for job definitions.
type JobDefinitionPermissionsSummary struct {
// An array of permissions.
UserPermissions []string `mandatory:"false" json:"userPermissions"`
// The unique key of the parent job definition.
JobDefinitionKey *string `mandatory:"false" json:"jobDefinitionKey"`
}
func (m JobDefinitionPermissionsSummary) String() string
func (m JobDefinitionPermissionsSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobDefinitionScope Defines the rules or criteria based on which the scope for job definition is circumscribed.
type JobDefinitionScope struct {
// Name of the folder or schema for this metadata harvest.
FolderName *string `mandatory:"false" json:"folderName"`
// Name of the entity for this metadata harvest.
EntityName *string `mandatory:"false" json:"entityName"`
// Filter rules with regular expression to specify folder names for this metadata harvest.
FolderNameFilter *string `mandatory:"false" json:"folderNameFilter"`
// Filter rules with regular expression to specify entity names for this metadata harvest.
EntityNameFilter *string `mandatory:"false" json:"entityNameFilter"`
// Specify if sample data to be extracted as part of this harvest.
IsSampleDataExtracted *bool `mandatory:"false" json:"isSampleDataExtracted"`
// Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
SampleDataSizeInMBs *int `mandatory:"false" json:"sampleDataSizeInMBs"`
}
func (m JobDefinitionScope) String() string
func (m JobDefinitionScope) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobDefinitionSummary A list of job definition resources. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.
type JobDefinitionSummary struct {
// Unique key of the job definition resource that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the job definition.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// URI to the job definition instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Type of the job definition.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// Lifecycle state of the job definition.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Specify if sample data to be extracted as part of this harvest.
IsSampleDataExtracted *bool `mandatory:"false" json:"isSampleDataExtracted"`
// The date and time the job definition was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The key of the connection resource used in harvest, sampling, profiling jobs.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
// Time that the latest job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeLatestExecutionStarted *common.SDKTime `mandatory:"false" json:"timeLatestExecutionStarted"`
// Time that the latest job execution ended or null if it hasn't yet completed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeLatestExecutionEnded *common.SDKTime `mandatory:"false" json:"timeLatestExecutionEnded"`
// Status of the latest job execution, such as running, paused, or completed.
JobExecutionState JobExecutionStateEnum `mandatory:"false" json:"jobExecutionState,omitempty"`
// Type of job schedule for the latest job executed.
ScheduleType JobScheduleTypeEnum `mandatory:"false" json:"scheduleType,omitempty"`
// Unique key of the data asset to which this job applies, if the job involves a data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies, if the job involves a glossary.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
}
func (m JobDefinitionSummary) String() string
func (m JobDefinitionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobExecution A job execution is a unit of work being executed on behalf of a job.
type JobExecution struct {
// Unique key of the job execution resource.
Key *string `mandatory:"true" json:"key"`
// The unique key of the parent job.
JobKey *string `mandatory:"false" json:"jobKey"`
// Type of the job execution.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// Sub-type of this job execution.
SubType *string `mandatory:"false" json:"subType"`
// The unique key of the parent execution or null if this job execution has no parent.
ParentKey *string `mandatory:"false" json:"parentKey"`
// The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
ScheduleInstanceKey *string `mandatory:"false" json:"scheduleInstanceKey"`
// Status of the job execution, such as running, paused, or completed.
LifecycleState JobExecutionStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the job execution was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time that job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Time that the job execution ended or null if it hasn't yet completed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// Error code returned from the job execution or null if job is still running or didn't return an error.
ErrorCode *string `mandatory:"false" json:"errorCode"`
// Error message returned from the job execution or null if job is still running or didn't return an error.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
// Process identifier related to the job execution if the job is an external job.
ProcessKey *string `mandatory:"false" json:"processKey"`
// If the job is an external process, then a URL of the job for accessing this resource and its status.
ExternalUrl *string `mandatory:"false" json:"externalUrl"`
// An identifier used for log message correlation.
EventKey *string `mandatory:"false" json:"eventKey"`
// The key of the associated data entity resource.
DataEntityKey *string `mandatory:"false" json:"dataEntityKey"`
// OCID of the user who created the job execution.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated the job execution.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// URI to the job execution instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// A map of maps that contains the execution context properties which are specific to a job execution. Each job
// execution may define it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// job executions have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m JobExecution) String() string
func (m JobExecution) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobExecutionCollection Results of a job executions listing. Job executions are execution instances of a scheduled job.
type JobExecutionCollection struct {
// Collection of job executions.
Items []JobExecutionSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m JobExecutionCollection) String() string
func (m JobExecutionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobExecutionStateEnum Enum with underlying type: string
type JobExecutionStateEnum string
Set of constants representing the allowable values for JobExecutionStateEnum
const (
JobExecutionStateCreated JobExecutionStateEnum = "CREATED"
JobExecutionStateInProgress JobExecutionStateEnum = "IN_PROGRESS"
JobExecutionStateInactive JobExecutionStateEnum = "INACTIVE"
JobExecutionStateFailed JobExecutionStateEnum = "FAILED"
JobExecutionStateSucceeded JobExecutionStateEnum = "SUCCEEDED"
JobExecutionStateCanceled JobExecutionStateEnum = "CANCELED"
JobExecutionStateSucceededWithWarnings JobExecutionStateEnum = "SUCCEEDED_WITH_WARNINGS"
)
func GetJobExecutionStateEnumValues() []JobExecutionStateEnum
GetJobExecutionStateEnumValues Enumerates the set of values for JobExecutionStateEnum
func GetMappingJobExecutionStateEnum(val string) (JobExecutionStateEnum, bool)
GetMappingJobExecutionStateEnum performs case Insensitive comparison on enum value and return the desired enum
JobExecutionSummary A list of job executions. A job execution is a unit of work being executed on behalf of a job.
type JobExecutionSummary struct {
// Unique key of the job execution resource.
Key *string `mandatory:"true" json:"key"`
// The unique key of the parent job.
JobKey *string `mandatory:"false" json:"jobKey"`
// Type of the job execution.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// The unique key of the parent execution or null if this job execution has no parent.
ParentKey *string `mandatory:"false" json:"parentKey"`
// The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
ScheduleInstanceKey *string `mandatory:"false" json:"scheduleInstanceKey"`
// Status of the job execution, such as running, paused, or completed.
LifecycleState JobExecutionStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the job execution was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time that job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Time that the job execution ended or null if it hasn't yet completed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// URI to the job execution instance in the API.
Uri *string `mandatory:"false" json:"uri"`
}
func (m JobExecutionSummary) String() string
func (m JobExecutionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobLifecycleStateEnum Enum with underlying type: string
type JobLifecycleStateEnum string
Set of constants representing the allowable values for JobLifecycleStateEnum
const (
JobLifecycleStateActive JobLifecycleStateEnum = "ACTIVE"
JobLifecycleStateInactive JobLifecycleStateEnum = "INACTIVE"
JobLifecycleStateExpired JobLifecycleStateEnum = "EXPIRED"
)
func GetJobLifecycleStateEnumValues() []JobLifecycleStateEnum
GetJobLifecycleStateEnumValues Enumerates the set of values for JobLifecycleStateEnum
func GetMappingJobLifecycleStateEnum(val string) (JobLifecycleStateEnum, bool)
GetMappingJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
JobLog Job log details. A job log is an audit log record inserted during the lifecycle of a job execution instance.
type JobLog struct {
// Unique key of the job log that is immutable.
Key *string `mandatory:"true" json:"key"`
// The unique key of the parent job execution for which the log resource was created.
JobExecutionKey *string `mandatory:"false" json:"jobExecutionKey"`
// OCID of the user who created the log record for this job. Usually the executor of the job instance.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who created the log record for this job. Usually the executor of the job instance.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Job log update time. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the job log was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Severity level for this log.
Severity *string `mandatory:"false" json:"severity"`
// Message for this job log.
LogMessage *string `mandatory:"false" json:"logMessage"`
// URI to the job log instance in the API.
Uri *string `mandatory:"false" json:"uri"`
}
func (m JobLog) String() string
func (m JobLog) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobLogCollection Results of a job logs Listing. A job log is an audit log record inserted during the lifecycle of a job execution instance.
type JobLogCollection struct {
// Collection of Job logs.
Items []JobLogSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m JobLogCollection) String() string
func (m JobLogCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobLogSummary A list of job execution logs. A job log is an audit log record inserted during the lifecycle of a job execution instance. There can be one or more logs for an execution instance.
type JobLogSummary struct {
// Unique key of the job log that is immutable.
Key *string `mandatory:"true" json:"key"`
// The unique key of the parent job execution for which the log resource was created.
JobExecutionKey *string `mandatory:"false" json:"jobExecutionKey"`
// URI to the job log instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The date and time the job log was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Severity level for this log.
Severity *string `mandatory:"false" json:"severity"`
// Message for this job log.
LogMessage *string `mandatory:"false" json:"logMessage"`
}
func (m JobLogSummary) String() string
func (m JobLogSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobMetric A set of metrics are collected periodically to assess the state and performance characteristics of the execution instance of a job. The metrics are grouped based on their category and sub categories and aggregated based on their batch information.
type JobMetric struct {
// Key of the job metric that is immutable.
Key *string `mandatory:"true" json:"key"`
// Detailed description of the metric.
Description *string `mandatory:"false" json:"description"`
// The unique key of the parent job execution for which the job metric resource is being created.
JobExecutionKey *string `mandatory:"false" json:"jobExecutionKey"`
// The time the metric was logged or captured in the system where the job executed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeInserted *common.SDKTime `mandatory:"false" json:"timeInserted"`
// Category of this metric.
Category *string `mandatory:"false" json:"category"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Sub category of this metric under the category. Used for aggregating values. May be null.
SubCategory *string `mandatory:"false" json:"subCategory"`
// Unit of this metric.
Unit *string `mandatory:"false" json:"unit"`
// Value of this metric.
Value *string `mandatory:"false" json:"value"`
// Batch key for grouping, may be null.
BatchKey *string `mandatory:"false" json:"batchKey"`
// URI to the job metric instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The date and time the job metric was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that this metric was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the metric for this job. Usually the executor of the job instance.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who created the metric for this job. Usually the executor of the job instance.
UpdatedById *string `mandatory:"false" json:"updatedById"`
}
func (m JobMetric) String() string
func (m JobMetric) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobMetricCollection Results of a job metrics listing. Job metrics are datum about a job execution in key value pairs.
type JobMetricCollection struct {
// Collection of job metrics.
Items []JobMetricSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m JobMetricCollection) String() string
func (m JobMetricCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobMetricSummary Job metric summary.
type JobMetricSummary struct {
// Key of the job metric that is immutable.
Key *string `mandatory:"true" json:"key"`
// Detailed description of the metric.
Description *string `mandatory:"false" json:"description"`
// The unique key of the parent job execution for which the job metric resource was created.
JobExecutionKey *string `mandatory:"false" json:"jobExecutionKey"`
// URI to the job metric instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The date and time the job metric was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the metric was logged or captured in the system where the job executed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeInserted *common.SDKTime `mandatory:"false" json:"timeInserted"`
// Category of this metric.
Category *string `mandatory:"false" json:"category"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Sub category of this metric under the category. Used for aggregating values. May be null.
SubCategory *string `mandatory:"false" json:"subCategory"`
// Unit of this metric.
Unit *string `mandatory:"false" json:"unit"`
// Value of this metric.
Value *string `mandatory:"false" json:"value"`
// Batch key for grouping, may be null.
BatchKey *string `mandatory:"false" json:"batchKey"`
}
func (m JobMetricSummary) String() string
func (m JobMetricSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobScheduleTypeEnum Enum with underlying type: string
type JobScheduleTypeEnum string
Set of constants representing the allowable values for JobScheduleTypeEnum
const (
JobScheduleTypeScheduled JobScheduleTypeEnum = "SCHEDULED"
JobScheduleTypeImmediate JobScheduleTypeEnum = "IMMEDIATE"
)
func GetJobScheduleTypeEnumValues() []JobScheduleTypeEnum
GetJobScheduleTypeEnumValues Enumerates the set of values for JobScheduleTypeEnum
func GetMappingJobScheduleTypeEnum(val string) (JobScheduleTypeEnum, bool)
GetMappingJobScheduleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
JobSummary Details of a job. Jobs are scheduled instances of a job definition.
type JobSummary struct {
// Unique key of the job.
Key *string `mandatory:"true" json:"key"`
// URI to the job instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// The unique key of the job definition resource that defined the scope of this job.
JobDefinitionKey *string `mandatory:"false" json:"jobDefinitionKey"`
// Lifecycle state of the job, such as running, paused, or completed.
LifecycleState JobLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Type of the job.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// Type of job schedule that is inferred from the scheduling properties.
ScheduleType *string `mandatory:"false" json:"scheduleType"`
// Detailed description of the job.
Description *string `mandatory:"false" json:"description"`
// The date and time the job was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time that this job was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created this job.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated this job.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".
// The following subset of those is supported: @monthly, @weekly, @daily, @hourly.
// For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.
ScheduleCronExpression *string `mandatory:"false" json:"scheduleCronExpression"`
// Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleBegin *common.SDKTime `mandatory:"false" json:"timeScheduleBegin"`
// The total number of executions for this job schedule.
ExecutionCount *int `mandatory:"false" json:"executionCount"`
// The date and time of the most recent execution for this job, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeOfLatestExecution *common.SDKTime `mandatory:"false" json:"timeOfLatestExecution"`
// The display name of the job definition resource that defined the scope of this job.
JobDefinitionName *string `mandatory:"false" json:"jobDefinitionName"`
// Unique key of the data asset to which this job applies, if the job involves a data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.
ErrorCode *string `mandatory:"false" json:"errorCode"`
// Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
// Array of the executions summary associated with this job.
Executions []JobExecutionSummary `mandatory:"false" json:"executions"`
}
func (m JobSummary) String() string
func (m JobSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobTypeEnum Enum with underlying type: string
type JobTypeEnum string
Set of constants representing the allowable values for JobTypeEnum
const (
JobTypeHarvest JobTypeEnum = "HARVEST"
JobTypeProfiling JobTypeEnum = "PROFILING"
JobTypeSampling JobTypeEnum = "SAMPLING"
JobTypePreview JobTypeEnum = "PREVIEW"
JobTypeImport JobTypeEnum = "IMPORT"
JobTypeExport JobTypeEnum = "EXPORT"
JobTypeImportGlossary JobTypeEnum = "IMPORT_GLOSSARY"
JobTypeExportGlossary JobTypeEnum = "EXPORT_GLOSSARY"
JobTypeInternal JobTypeEnum = "INTERNAL"
JobTypePurge JobTypeEnum = "PURGE"
JobTypeImmediate JobTypeEnum = "IMMEDIATE"
JobTypeScheduled JobTypeEnum = "SCHEDULED"
JobTypeImmediateExecution JobTypeEnum = "IMMEDIATE_EXECUTION"
JobTypeScheduledExecution JobTypeEnum = "SCHEDULED_EXECUTION"
JobTypeScheduledExecutionInstance JobTypeEnum = "SCHEDULED_EXECUTION_INSTANCE"
JobTypeAsyncDelete JobTypeEnum = "ASYNC_DELETE"
JobTypeImportDataAsset JobTypeEnum = "IMPORT_DATA_ASSET"
JobTypeCreateScanProxy JobTypeEnum = "CREATE_SCAN_PROXY"
JobTypeAsyncExportGlossary JobTypeEnum = "ASYNC_EXPORT_GLOSSARY"
JobTypeAsyncExportDataAsset JobTypeEnum = "ASYNC_EXPORT_DATA_ASSET"
)
func GetJobTypeEnumValues() []JobTypeEnum
GetJobTypeEnumValues Enumerates the set of values for JobTypeEnum
func GetMappingJobTypeEnum(val string) (JobTypeEnum, bool)
GetMappingJobTypeEnum 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"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
LifecycleStateMoving LifecycleStateEnum = "MOVING"
)
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
LineageDirectionEnum Enum with underlying type: string
type LineageDirectionEnum string
Set of constants representing the allowable values for LineageDirectionEnum
const (
LineageDirectionUpstream LineageDirectionEnum = "UPSTREAM"
LineageDirectionBoth LineageDirectionEnum = "BOTH"
LineageDirectionDownstream LineageDirectionEnum = "DOWNSTREAM"
)
func GetLineageDirectionEnumValues() []LineageDirectionEnum
GetLineageDirectionEnumValues Enumerates the set of values for LineageDirectionEnum
func GetMappingLineageDirectionEnum(val string) (LineageDirectionEnum, bool)
GetMappingLineageDirectionEnum performs case Insensitive comparison on enum value and return the desired enum
LineageObject Object describing an individual element of object lineage.
type LineageObject struct {
// Key of the object, such as an entity, about which this lineage applies.
ObjectKey *string `mandatory:"false" json:"objectKey"`
// Display name of the object.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the object.
Description *string `mandatory:"false" json:"description"`
// Indicates if intra-lineage is available for this given object. If yes, drill-down can be requested for
// this object.
IsIntraLineageAvailable *bool `mandatory:"false" json:"isIntraLineageAvailable"`
// Key of the parent object for this object.
ParentKey *string `mandatory:"false" json:"parentKey"`
// Full path of the parent object.
ParentPath *string `mandatory:"false" json:"parentPath"`
// The time that this object was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time that this object was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Type name of the object. Type keys can be found via the '/types' endpoint.
TypeName *string `mandatory:"false" json:"typeName"`
// Type key of the object. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// A map of maps that contains the properties which are specific to the entity type. Each entity type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data entities have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m LineageObject) String() string
func (m LineageObject) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
LineageRelationship Declares how two elements of object lineage are related.
type LineageRelationship struct {
// Object key of source lineage element.
FromObjectKey *string `mandatory:"false" json:"fromObjectKey"`
// Object key of target lineage element.
ToObjectKey *string `mandatory:"false" json:"toObjectKey"`
// Type of the relationship.
RelationshipType *string `mandatory:"false" json:"relationshipType"`
}
func (m LineageRelationship) String() string
func (m LineageRelationship) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAggregatedPhysicalEntitiesFieldsEnum Enum with underlying type: string
type ListAggregatedPhysicalEntitiesFieldsEnum string
Set of constants representing the allowable values for ListAggregatedPhysicalEntitiesFieldsEnum
const (
ListAggregatedPhysicalEntitiesFieldsKey ListAggregatedPhysicalEntitiesFieldsEnum = "key"
ListAggregatedPhysicalEntitiesFieldsDisplayname ListAggregatedPhysicalEntitiesFieldsEnum = "displayName"
ListAggregatedPhysicalEntitiesFieldsDescription ListAggregatedPhysicalEntitiesFieldsEnum = "description"
ListAggregatedPhysicalEntitiesFieldsDataassetkey ListAggregatedPhysicalEntitiesFieldsEnum = "dataAssetKey"
ListAggregatedPhysicalEntitiesFieldsTimecreated ListAggregatedPhysicalEntitiesFieldsEnum = "timeCreated"
ListAggregatedPhysicalEntitiesFieldsTimeupdated ListAggregatedPhysicalEntitiesFieldsEnum = "timeUpdated"
ListAggregatedPhysicalEntitiesFieldsCreatedbyid ListAggregatedPhysicalEntitiesFieldsEnum = "createdById"
ListAggregatedPhysicalEntitiesFieldsUpdatedbyid ListAggregatedPhysicalEntitiesFieldsEnum = "updatedById"
ListAggregatedPhysicalEntitiesFieldsLifecyclestate ListAggregatedPhysicalEntitiesFieldsEnum = "lifecycleState"
ListAggregatedPhysicalEntitiesFieldsExternalkey ListAggregatedPhysicalEntitiesFieldsEnum = "externalKey"
ListAggregatedPhysicalEntitiesFieldsTimeexternal ListAggregatedPhysicalEntitiesFieldsEnum = "timeExternal"
ListAggregatedPhysicalEntitiesFieldsTimestatusupdated ListAggregatedPhysicalEntitiesFieldsEnum = "timeStatusUpdated"
ListAggregatedPhysicalEntitiesFieldsIslogical ListAggregatedPhysicalEntitiesFieldsEnum = "isLogical"
ListAggregatedPhysicalEntitiesFieldsIspartition ListAggregatedPhysicalEntitiesFieldsEnum = "isPartition"
ListAggregatedPhysicalEntitiesFieldsFolderkey ListAggregatedPhysicalEntitiesFieldsEnum = "folderKey"
ListAggregatedPhysicalEntitiesFieldsFoldername ListAggregatedPhysicalEntitiesFieldsEnum = "folderName"
ListAggregatedPhysicalEntitiesFieldsTypekey ListAggregatedPhysicalEntitiesFieldsEnum = "typeKey"
ListAggregatedPhysicalEntitiesFieldsPath ListAggregatedPhysicalEntitiesFieldsEnum = "path"
ListAggregatedPhysicalEntitiesFieldsHarveststatus ListAggregatedPhysicalEntitiesFieldsEnum = "harvestStatus"
ListAggregatedPhysicalEntitiesFieldsLastjobkey ListAggregatedPhysicalEntitiesFieldsEnum = "lastJobKey"
ListAggregatedPhysicalEntitiesFieldsUri ListAggregatedPhysicalEntitiesFieldsEnum = "uri"
ListAggregatedPhysicalEntitiesFieldsProperties ListAggregatedPhysicalEntitiesFieldsEnum = "properties"
)
func GetListAggregatedPhysicalEntitiesFieldsEnumValues() []ListAggregatedPhysicalEntitiesFieldsEnum
GetListAggregatedPhysicalEntitiesFieldsEnumValues Enumerates the set of values for ListAggregatedPhysicalEntitiesFieldsEnum
func GetMappingListAggregatedPhysicalEntitiesFieldsEnum(val string) (ListAggregatedPhysicalEntitiesFieldsEnum, bool)
GetMappingListAggregatedPhysicalEntitiesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListAggregatedPhysicalEntitiesRequest wrapper for the ListAggregatedPhysicalEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAggregatedPhysicalEntities.go.html to see an example of how to use ListAggregatedPhysicalEntitiesRequest.
type ListAggregatedPhysicalEntitiesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Specifies the fields to return in an entity response.
Fields []ListAggregatedPhysicalEntitiesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListAggregatedPhysicalEntitiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListAggregatedPhysicalEntitiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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"`
// Indicates whether the properties map will be provided in the response.
IsIncludeProperties *bool `mandatory:"false" contributesTo:"query" name:"isIncludeProperties"`
// 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 ListAggregatedPhysicalEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAggregatedPhysicalEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAggregatedPhysicalEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAggregatedPhysicalEntitiesRequest) String() string
func (request ListAggregatedPhysicalEntitiesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAggregatedPhysicalEntitiesResponse wrapper for the ListAggregatedPhysicalEntities operation
type ListAggregatedPhysicalEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EntityCollection instances
EntityCollection `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"`
}
func (response ListAggregatedPhysicalEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAggregatedPhysicalEntitiesResponse) String() string
ListAggregatedPhysicalEntitiesSortByEnum Enum with underlying type: string
type ListAggregatedPhysicalEntitiesSortByEnum string
Set of constants representing the allowable values for ListAggregatedPhysicalEntitiesSortByEnum
const (
ListAggregatedPhysicalEntitiesSortByTimecreated ListAggregatedPhysicalEntitiesSortByEnum = "TIMECREATED"
ListAggregatedPhysicalEntitiesSortByDisplayname ListAggregatedPhysicalEntitiesSortByEnum = "DISPLAYNAME"
)
func GetListAggregatedPhysicalEntitiesSortByEnumValues() []ListAggregatedPhysicalEntitiesSortByEnum
GetListAggregatedPhysicalEntitiesSortByEnumValues Enumerates the set of values for ListAggregatedPhysicalEntitiesSortByEnum
func GetMappingListAggregatedPhysicalEntitiesSortByEnum(val string) (ListAggregatedPhysicalEntitiesSortByEnum, bool)
GetMappingListAggregatedPhysicalEntitiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAggregatedPhysicalEntitiesSortOrderEnum Enum with underlying type: string
type ListAggregatedPhysicalEntitiesSortOrderEnum string
Set of constants representing the allowable values for ListAggregatedPhysicalEntitiesSortOrderEnum
const (
ListAggregatedPhysicalEntitiesSortOrderAsc ListAggregatedPhysicalEntitiesSortOrderEnum = "ASC"
ListAggregatedPhysicalEntitiesSortOrderDesc ListAggregatedPhysicalEntitiesSortOrderEnum = "DESC"
)
func GetListAggregatedPhysicalEntitiesSortOrderEnumValues() []ListAggregatedPhysicalEntitiesSortOrderEnum
GetListAggregatedPhysicalEntitiesSortOrderEnumValues Enumerates the set of values for ListAggregatedPhysicalEntitiesSortOrderEnum
func GetMappingListAggregatedPhysicalEntitiesSortOrderEnum(val string) (ListAggregatedPhysicalEntitiesSortOrderEnum, bool)
GetMappingListAggregatedPhysicalEntitiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributeTagsFieldsEnum Enum with underlying type: string
type ListAttributeTagsFieldsEnum string
Set of constants representing the allowable values for ListAttributeTagsFieldsEnum
const (
ListAttributeTagsFieldsKey ListAttributeTagsFieldsEnum = "key"
ListAttributeTagsFieldsName ListAttributeTagsFieldsEnum = "name"
ListAttributeTagsFieldsTermkey ListAttributeTagsFieldsEnum = "termKey"
ListAttributeTagsFieldsTermpath ListAttributeTagsFieldsEnum = "termPath"
ListAttributeTagsFieldsTermdescription ListAttributeTagsFieldsEnum = "termDescription"
ListAttributeTagsFieldsLifecyclestate ListAttributeTagsFieldsEnum = "lifecycleState"
ListAttributeTagsFieldsTimecreated ListAttributeTagsFieldsEnum = "timeCreated"
ListAttributeTagsFieldsUri ListAttributeTagsFieldsEnum = "uri"
ListAttributeTagsFieldsGlossarykey ListAttributeTagsFieldsEnum = "glossaryKey"
ListAttributeTagsFieldsAttributekey ListAttributeTagsFieldsEnum = "attributeKey"
)
func GetListAttributeTagsFieldsEnumValues() []ListAttributeTagsFieldsEnum
GetListAttributeTagsFieldsEnumValues Enumerates the set of values for ListAttributeTagsFieldsEnum
func GetMappingListAttributeTagsFieldsEnum(val string) (ListAttributeTagsFieldsEnum, bool)
GetMappingListAttributeTagsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributeTagsLifecycleStateEnum Enum with underlying type: string
type ListAttributeTagsLifecycleStateEnum string
Set of constants representing the allowable values for ListAttributeTagsLifecycleStateEnum
const (
ListAttributeTagsLifecycleStateCreating ListAttributeTagsLifecycleStateEnum = "CREATING"
ListAttributeTagsLifecycleStateActive ListAttributeTagsLifecycleStateEnum = "ACTIVE"
ListAttributeTagsLifecycleStateInactive ListAttributeTagsLifecycleStateEnum = "INACTIVE"
ListAttributeTagsLifecycleStateUpdating ListAttributeTagsLifecycleStateEnum = "UPDATING"
ListAttributeTagsLifecycleStateDeleting ListAttributeTagsLifecycleStateEnum = "DELETING"
ListAttributeTagsLifecycleStateDeleted ListAttributeTagsLifecycleStateEnum = "DELETED"
ListAttributeTagsLifecycleStateFailed ListAttributeTagsLifecycleStateEnum = "FAILED"
ListAttributeTagsLifecycleStateMoving ListAttributeTagsLifecycleStateEnum = "MOVING"
)
func GetListAttributeTagsLifecycleStateEnumValues() []ListAttributeTagsLifecycleStateEnum
GetListAttributeTagsLifecycleStateEnumValues Enumerates the set of values for ListAttributeTagsLifecycleStateEnum
func GetMappingListAttributeTagsLifecycleStateEnum(val string) (ListAttributeTagsLifecycleStateEnum, bool)
GetMappingListAttributeTagsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributeTagsRequest wrapper for the ListAttributeTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAttributeTags.go.html to see an example of how to use ListAttributeTagsRequest.
type ListAttributeTagsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique attribute key.
AttributeKey *string `mandatory:"true" contributesTo:"path" name:"attributeKey"`
// Immutable resource name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListAttributeTagsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique key of the related term.
TermKey *string `mandatory:"false" contributesTo:"query" name:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" contributesTo:"query" name:"termPath"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// Specifies the fields to return in an entity attribute tag summary response.
Fields []ListAttributeTagsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListAttributeTagsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListAttributeTagsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListAttributeTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAttributeTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAttributeTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAttributeTagsRequest) String() string
func (request ListAttributeTagsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAttributeTagsResponse wrapper for the ListAttributeTags operation
type ListAttributeTagsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AttributeTagCollection instances
AttributeTagCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAttributeTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAttributeTagsResponse) String() string
ListAttributeTagsSortByEnum Enum with underlying type: string
type ListAttributeTagsSortByEnum string
Set of constants representing the allowable values for ListAttributeTagsSortByEnum
const (
ListAttributeTagsSortByTimecreated ListAttributeTagsSortByEnum = "TIMECREATED"
ListAttributeTagsSortByDisplayname ListAttributeTagsSortByEnum = "DISPLAYNAME"
)
func GetListAttributeTagsSortByEnumValues() []ListAttributeTagsSortByEnum
GetListAttributeTagsSortByEnumValues Enumerates the set of values for ListAttributeTagsSortByEnum
func GetMappingListAttributeTagsSortByEnum(val string) (ListAttributeTagsSortByEnum, bool)
GetMappingListAttributeTagsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributeTagsSortOrderEnum Enum with underlying type: string
type ListAttributeTagsSortOrderEnum string
Set of constants representing the allowable values for ListAttributeTagsSortOrderEnum
const (
ListAttributeTagsSortOrderAsc ListAttributeTagsSortOrderEnum = "ASC"
ListAttributeTagsSortOrderDesc ListAttributeTagsSortOrderEnum = "DESC"
)
func GetListAttributeTagsSortOrderEnumValues() []ListAttributeTagsSortOrderEnum
GetListAttributeTagsSortOrderEnumValues Enumerates the set of values for ListAttributeTagsSortOrderEnum
func GetMappingListAttributeTagsSortOrderEnum(val string) (ListAttributeTagsSortOrderEnum, bool)
GetMappingListAttributeTagsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributesFieldsEnum Enum with underlying type: string
type ListAttributesFieldsEnum string
Set of constants representing the allowable values for ListAttributesFieldsEnum
const (
ListAttributesFieldsKey ListAttributesFieldsEnum = "key"
ListAttributesFieldsDisplayname ListAttributesFieldsEnum = "displayName"
ListAttributesFieldsDescription ListAttributesFieldsEnum = "description"
ListAttributesFieldsEntitykey ListAttributesFieldsEnum = "entityKey"
ListAttributesFieldsLifecyclestate ListAttributesFieldsEnum = "lifecycleState"
ListAttributesFieldsTimecreated ListAttributesFieldsEnum = "timeCreated"
ListAttributesFieldsExternaldatatype ListAttributesFieldsEnum = "externalDataType"
ListAttributesFieldsExternalkey ListAttributesFieldsEnum = "externalKey"
ListAttributesFieldsLength ListAttributesFieldsEnum = "length"
ListAttributesFieldsPrecision ListAttributesFieldsEnum = "precision"
ListAttributesFieldsScale ListAttributesFieldsEnum = "scale"
ListAttributesFieldsIsnullable ListAttributesFieldsEnum = "isNullable"
ListAttributesFieldsUri ListAttributesFieldsEnum = "uri"
ListAttributesFieldsPath ListAttributesFieldsEnum = "path"
ListAttributesFieldsMincollectioncount ListAttributesFieldsEnum = "minCollectionCount"
ListAttributesFieldsMaxcollectioncount ListAttributesFieldsEnum = "maxCollectionCount"
ListAttributesFieldsDatatypeentitykey ListAttributesFieldsEnum = "datatypeEntityKey"
ListAttributesFieldsExternaldatatypeentitykey ListAttributesFieldsEnum = "externalDatatypeEntityKey"
ListAttributesFieldsParentattributekey ListAttributesFieldsEnum = "parentAttributeKey"
ListAttributesFieldsExternalparentattributekey ListAttributesFieldsEnum = "externalParentAttributeKey"
ListAttributesFieldsPosition ListAttributesFieldsEnum = "position"
ListAttributesFieldsTypekey ListAttributesFieldsEnum = "typeKey"
)
func GetListAttributesFieldsEnumValues() []ListAttributesFieldsEnum
GetListAttributesFieldsEnumValues Enumerates the set of values for ListAttributesFieldsEnum
func GetMappingListAttributesFieldsEnum(val string) (ListAttributesFieldsEnum, bool)
GetMappingListAttributesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributesLifecycleStateEnum Enum with underlying type: string
type ListAttributesLifecycleStateEnum string
Set of constants representing the allowable values for ListAttributesLifecycleStateEnum
const (
ListAttributesLifecycleStateCreating ListAttributesLifecycleStateEnum = "CREATING"
ListAttributesLifecycleStateActive ListAttributesLifecycleStateEnum = "ACTIVE"
ListAttributesLifecycleStateInactive ListAttributesLifecycleStateEnum = "INACTIVE"
ListAttributesLifecycleStateUpdating ListAttributesLifecycleStateEnum = "UPDATING"
ListAttributesLifecycleStateDeleting ListAttributesLifecycleStateEnum = "DELETING"
ListAttributesLifecycleStateDeleted ListAttributesLifecycleStateEnum = "DELETED"
ListAttributesLifecycleStateFailed ListAttributesLifecycleStateEnum = "FAILED"
ListAttributesLifecycleStateMoving ListAttributesLifecycleStateEnum = "MOVING"
)
func GetListAttributesLifecycleStateEnumValues() []ListAttributesLifecycleStateEnum
GetListAttributesLifecycleStateEnumValues Enumerates the set of values for ListAttributesLifecycleStateEnum
func GetMappingListAttributesLifecycleStateEnum(val string) (ListAttributesLifecycleStateEnum, bool)
GetMappingListAttributesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributesRequest wrapper for the ListAttributes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAttributes.go.html to see an example of how to use ListAttributesRequest.
type ListAttributesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the entire business name given. The match is not case sensitive.
BusinessName *string `mandatory:"false" contributesTo:"query" name:"businessName"`
// A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.
// For Example : /folders?displayOrBusinessNameContains=Cu.*
// The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayOrBusinessNameContains *string `mandatory:"false" contributesTo:"query" name:"displayOrBusinessNameContains"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListAttributesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Unique external identifier of this resource in the external source system.
ExternalKey *string `mandatory:"false" contributesTo:"query" name:"externalKey"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeExternal"`
// Data type as defined in an external system.
ExternalTypeName *string `mandatory:"false" contributesTo:"query" name:"externalTypeName"`
// Identifies whether this attribute can be used as a watermark to extract incremental data.
IsIncrementalData *bool `mandatory:"false" contributesTo:"query" name:"isIncrementalData"`
// Identifies whether this attribute can be assigned null value.
IsNullable *bool `mandatory:"false" contributesTo:"query" name:"isNullable"`
// Max allowed length of the attribute value.
Length *int64 `mandatory:"false" contributesTo:"query" name:"length"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" contributesTo:"query" name:"position"`
// Precision of the attribute value usually applies to float data type.
Precision *int `mandatory:"false" contributesTo:"query" name:"precision"`
// Scale of the attribute value usually applies to float data type.
Scale *int `mandatory:"false" contributesTo:"query" name:"scale"`
// Specifies the fields to return in an entity attribute summary response.
Fields []ListAttributesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.
// Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default.
SortBy ListAttributesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListAttributesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListAttributesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAttributesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAttributesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAttributesRequest) String() string
func (request ListAttributesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAttributesResponse wrapper for the ListAttributes operation
type ListAttributesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AttributeCollection instances
AttributeCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAttributesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAttributesResponse) String() string
ListAttributesSortByEnum Enum with underlying type: string
type ListAttributesSortByEnum string
Set of constants representing the allowable values for ListAttributesSortByEnum
const (
ListAttributesSortByTimecreated ListAttributesSortByEnum = "TIMECREATED"
ListAttributesSortByDisplayname ListAttributesSortByEnum = "DISPLAYNAME"
ListAttributesSortByPosition ListAttributesSortByEnum = "POSITION"
ListAttributesSortByDisplayorbusinessname ListAttributesSortByEnum = "DISPLAYORBUSINESSNAME"
)
func GetListAttributesSortByEnumValues() []ListAttributesSortByEnum
GetListAttributesSortByEnumValues Enumerates the set of values for ListAttributesSortByEnum
func GetMappingListAttributesSortByEnum(val string) (ListAttributesSortByEnum, bool)
GetMappingListAttributesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAttributesSortOrderEnum Enum with underlying type: string
type ListAttributesSortOrderEnum string
Set of constants representing the allowable values for ListAttributesSortOrderEnum
const (
ListAttributesSortOrderAsc ListAttributesSortOrderEnum = "ASC"
ListAttributesSortOrderDesc ListAttributesSortOrderEnum = "DESC"
)
func GetListAttributesSortOrderEnumValues() []ListAttributesSortOrderEnum
GetListAttributesSortOrderEnumValues Enumerates the set of values for ListAttributesSortOrderEnum
func GetMappingListAttributesSortOrderEnum(val string) (ListAttributesSortOrderEnum, bool)
GetMappingListAttributesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCatalogPrivateEndpointsLifecycleStateEnum Enum with underlying type: string
type ListCatalogPrivateEndpointsLifecycleStateEnum string
Set of constants representing the allowable values for ListCatalogPrivateEndpointsLifecycleStateEnum
const (
ListCatalogPrivateEndpointsLifecycleStateCreating ListCatalogPrivateEndpointsLifecycleStateEnum = "CREATING"
ListCatalogPrivateEndpointsLifecycleStateActive ListCatalogPrivateEndpointsLifecycleStateEnum = "ACTIVE"
ListCatalogPrivateEndpointsLifecycleStateInactive ListCatalogPrivateEndpointsLifecycleStateEnum = "INACTIVE"
ListCatalogPrivateEndpointsLifecycleStateUpdating ListCatalogPrivateEndpointsLifecycleStateEnum = "UPDATING"
ListCatalogPrivateEndpointsLifecycleStateDeleting ListCatalogPrivateEndpointsLifecycleStateEnum = "DELETING"
ListCatalogPrivateEndpointsLifecycleStateDeleted ListCatalogPrivateEndpointsLifecycleStateEnum = "DELETED"
ListCatalogPrivateEndpointsLifecycleStateFailed ListCatalogPrivateEndpointsLifecycleStateEnum = "FAILED"
ListCatalogPrivateEndpointsLifecycleStateMoving ListCatalogPrivateEndpointsLifecycleStateEnum = "MOVING"
)
func GetListCatalogPrivateEndpointsLifecycleStateEnumValues() []ListCatalogPrivateEndpointsLifecycleStateEnum
GetListCatalogPrivateEndpointsLifecycleStateEnumValues Enumerates the set of values for ListCatalogPrivateEndpointsLifecycleStateEnum
func GetMappingListCatalogPrivateEndpointsLifecycleStateEnum(val string) (ListCatalogPrivateEndpointsLifecycleStateEnum, bool)
GetMappingListCatalogPrivateEndpointsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListCatalogPrivateEndpointsRequest wrapper for the ListCatalogPrivateEndpoints operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListCatalogPrivateEndpoints.go.html to see an example of how to use ListCatalogPrivateEndpointsRequest.
type ListCatalogPrivateEndpointsRequest struct {
// The OCID of the compartment where you want to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
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"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListCatalogPrivateEndpointsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListCatalogPrivateEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListCatalogPrivateEndpointsSortByEnum `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 ListCatalogPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCatalogPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCatalogPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCatalogPrivateEndpointsRequest) String() string
func (request ListCatalogPrivateEndpointsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCatalogPrivateEndpointsResponse wrapper for the ListCatalogPrivateEndpoints operation
type ListCatalogPrivateEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []CatalogPrivateEndpointSummary instances
Items []CatalogPrivateEndpointSummary `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCatalogPrivateEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCatalogPrivateEndpointsResponse) String() string
ListCatalogPrivateEndpointsSortByEnum Enum with underlying type: string
type ListCatalogPrivateEndpointsSortByEnum string
Set of constants representing the allowable values for ListCatalogPrivateEndpointsSortByEnum
const (
ListCatalogPrivateEndpointsSortByTimecreated ListCatalogPrivateEndpointsSortByEnum = "TIMECREATED"
ListCatalogPrivateEndpointsSortByDisplayname ListCatalogPrivateEndpointsSortByEnum = "DISPLAYNAME"
)
func GetListCatalogPrivateEndpointsSortByEnumValues() []ListCatalogPrivateEndpointsSortByEnum
GetListCatalogPrivateEndpointsSortByEnumValues Enumerates the set of values for ListCatalogPrivateEndpointsSortByEnum
func GetMappingListCatalogPrivateEndpointsSortByEnum(val string) (ListCatalogPrivateEndpointsSortByEnum, bool)
GetMappingListCatalogPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCatalogPrivateEndpointsSortOrderEnum Enum with underlying type: string
type ListCatalogPrivateEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListCatalogPrivateEndpointsSortOrderEnum
const (
ListCatalogPrivateEndpointsSortOrderAsc ListCatalogPrivateEndpointsSortOrderEnum = "ASC"
ListCatalogPrivateEndpointsSortOrderDesc ListCatalogPrivateEndpointsSortOrderEnum = "DESC"
)
func GetListCatalogPrivateEndpointsSortOrderEnumValues() []ListCatalogPrivateEndpointsSortOrderEnum
GetListCatalogPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListCatalogPrivateEndpointsSortOrderEnum
func GetMappingListCatalogPrivateEndpointsSortOrderEnum(val string) (ListCatalogPrivateEndpointsSortOrderEnum, bool)
GetMappingListCatalogPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCatalogsLifecycleStateEnum Enum with underlying type: string
type ListCatalogsLifecycleStateEnum string
Set of constants representing the allowable values for ListCatalogsLifecycleStateEnum
const (
ListCatalogsLifecycleStateCreating ListCatalogsLifecycleStateEnum = "CREATING"
ListCatalogsLifecycleStateActive ListCatalogsLifecycleStateEnum = "ACTIVE"
ListCatalogsLifecycleStateInactive ListCatalogsLifecycleStateEnum = "INACTIVE"
ListCatalogsLifecycleStateUpdating ListCatalogsLifecycleStateEnum = "UPDATING"
ListCatalogsLifecycleStateDeleting ListCatalogsLifecycleStateEnum = "DELETING"
ListCatalogsLifecycleStateDeleted ListCatalogsLifecycleStateEnum = "DELETED"
ListCatalogsLifecycleStateFailed ListCatalogsLifecycleStateEnum = "FAILED"
ListCatalogsLifecycleStateMoving ListCatalogsLifecycleStateEnum = "MOVING"
)
func GetListCatalogsLifecycleStateEnumValues() []ListCatalogsLifecycleStateEnum
GetListCatalogsLifecycleStateEnumValues Enumerates the set of values for ListCatalogsLifecycleStateEnum
func GetMappingListCatalogsLifecycleStateEnum(val string) (ListCatalogsLifecycleStateEnum, bool)
GetMappingListCatalogsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListCatalogsRequest wrapper for the ListCatalogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListCatalogs.go.html to see an example of how to use ListCatalogsRequest.
type ListCatalogsRequest struct {
// The OCID of the compartment where you want to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
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"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListCatalogsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListCatalogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListCatalogsSortByEnum `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 ListCatalogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCatalogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCatalogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCatalogsRequest) String() string
func (request ListCatalogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCatalogsResponse wrapper for the ListCatalogs operation
type ListCatalogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []CatalogSummary instances
Items []CatalogSummary `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCatalogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCatalogsResponse) String() string
ListCatalogsSortByEnum Enum with underlying type: string
type ListCatalogsSortByEnum string
Set of constants representing the allowable values for ListCatalogsSortByEnum
const (
ListCatalogsSortByTimecreated ListCatalogsSortByEnum = "TIMECREATED"
ListCatalogsSortByDisplayname ListCatalogsSortByEnum = "DISPLAYNAME"
)
func GetListCatalogsSortByEnumValues() []ListCatalogsSortByEnum
GetListCatalogsSortByEnumValues Enumerates the set of values for ListCatalogsSortByEnum
func GetMappingListCatalogsSortByEnum(val string) (ListCatalogsSortByEnum, bool)
GetMappingListCatalogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCatalogsSortOrderEnum Enum with underlying type: string
type ListCatalogsSortOrderEnum string
Set of constants representing the allowable values for ListCatalogsSortOrderEnum
const (
ListCatalogsSortOrderAsc ListCatalogsSortOrderEnum = "ASC"
ListCatalogsSortOrderDesc ListCatalogsSortOrderEnum = "DESC"
)
func GetListCatalogsSortOrderEnumValues() []ListCatalogsSortOrderEnum
GetListCatalogsSortOrderEnumValues Enumerates the set of values for ListCatalogsSortOrderEnum
func GetMappingListCatalogsSortOrderEnum(val string) (ListCatalogsSortOrderEnum, bool)
GetMappingListCatalogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectionsFieldsEnum Enum with underlying type: string
type ListConnectionsFieldsEnum string
Set of constants representing the allowable values for ListConnectionsFieldsEnum
const (
ListConnectionsFieldsKey ListConnectionsFieldsEnum = "key"
ListConnectionsFieldsDisplayname ListConnectionsFieldsEnum = "displayName"
ListConnectionsFieldsDescription ListConnectionsFieldsEnum = "description"
ListConnectionsFieldsDataassetkey ListConnectionsFieldsEnum = "dataAssetKey"
ListConnectionsFieldsTypekey ListConnectionsFieldsEnum = "typeKey"
ListConnectionsFieldsTimecreated ListConnectionsFieldsEnum = "timeCreated"
ListConnectionsFieldsExternalkey ListConnectionsFieldsEnum = "externalKey"
ListConnectionsFieldsLifecyclestate ListConnectionsFieldsEnum = "lifecycleState"
ListConnectionsFieldsIsdefault ListConnectionsFieldsEnum = "isDefault"
ListConnectionsFieldsUri ListConnectionsFieldsEnum = "uri"
)
func GetListConnectionsFieldsEnumValues() []ListConnectionsFieldsEnum
GetListConnectionsFieldsEnumValues Enumerates the set of values for ListConnectionsFieldsEnum
func GetMappingListConnectionsFieldsEnum(val string) (ListConnectionsFieldsEnum, bool)
GetMappingListConnectionsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectionsLifecycleStateEnum Enum with underlying type: string
type ListConnectionsLifecycleStateEnum string
Set of constants representing the allowable values for ListConnectionsLifecycleStateEnum
const (
ListConnectionsLifecycleStateCreating ListConnectionsLifecycleStateEnum = "CREATING"
ListConnectionsLifecycleStateActive ListConnectionsLifecycleStateEnum = "ACTIVE"
ListConnectionsLifecycleStateInactive ListConnectionsLifecycleStateEnum = "INACTIVE"
ListConnectionsLifecycleStateUpdating ListConnectionsLifecycleStateEnum = "UPDATING"
ListConnectionsLifecycleStateDeleting ListConnectionsLifecycleStateEnum = "DELETING"
ListConnectionsLifecycleStateDeleted ListConnectionsLifecycleStateEnum = "DELETED"
ListConnectionsLifecycleStateFailed ListConnectionsLifecycleStateEnum = "FAILED"
ListConnectionsLifecycleStateMoving ListConnectionsLifecycleStateEnum = "MOVING"
)
func GetListConnectionsLifecycleStateEnumValues() []ListConnectionsLifecycleStateEnum
GetListConnectionsLifecycleStateEnumValues Enumerates the set of values for ListConnectionsLifecycleStateEnum
func GetMappingListConnectionsLifecycleStateEnum(val string) (ListConnectionsLifecycleStateEnum, bool)
GetMappingListConnectionsLifecycleStateEnum 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/datacatalog/ListConnections.go.html to see an example of how to use ListConnectionsRequest.
type ListConnectionsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListConnectionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Unique external identifier of this resource in the external source system.
ExternalKey *string `mandatory:"false" contributesTo:"query" name:"externalKey"`
// Time that the resource's status was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStatusUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeStatusUpdated"`
// Indicates whether this connection is the default connection.
IsDefault *bool `mandatory:"false" contributesTo:"query" name:"isDefault"`
// Specifies the fields to return in a connection summary response.
Fields []ListConnectionsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListConnectionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListConnectionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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"`
// 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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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
ListCustomPropertiesFieldsEnum Enum with underlying type: string
type ListCustomPropertiesFieldsEnum string
Set of constants representing the allowable values for ListCustomPropertiesFieldsEnum
const (
ListCustomPropertiesFieldsKey ListCustomPropertiesFieldsEnum = "key"
ListCustomPropertiesFieldsDisplayname ListCustomPropertiesFieldsEnum = "displayName"
ListCustomPropertiesFieldsDescription ListCustomPropertiesFieldsEnum = "description"
ListCustomPropertiesFieldsDatatype ListCustomPropertiesFieldsEnum = "dataType"
ListCustomPropertiesFieldsNamespacename ListCustomPropertiesFieldsEnum = "namespaceName"
ListCustomPropertiesFieldsLifecyclestate ListCustomPropertiesFieldsEnum = "lifecycleState"
ListCustomPropertiesFieldsTimecreated ListCustomPropertiesFieldsEnum = "timeCreated"
)
func GetListCustomPropertiesFieldsEnumValues() []ListCustomPropertiesFieldsEnum
GetListCustomPropertiesFieldsEnumValues Enumerates the set of values for ListCustomPropertiesFieldsEnum
func GetMappingListCustomPropertiesFieldsEnum(val string) (ListCustomPropertiesFieldsEnum, bool)
GetMappingListCustomPropertiesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListCustomPropertiesLifecycleStateEnum Enum with underlying type: string
type ListCustomPropertiesLifecycleStateEnum string
Set of constants representing the allowable values for ListCustomPropertiesLifecycleStateEnum
const (
ListCustomPropertiesLifecycleStateCreating ListCustomPropertiesLifecycleStateEnum = "CREATING"
ListCustomPropertiesLifecycleStateActive ListCustomPropertiesLifecycleStateEnum = "ACTIVE"
ListCustomPropertiesLifecycleStateInactive ListCustomPropertiesLifecycleStateEnum = "INACTIVE"
ListCustomPropertiesLifecycleStateUpdating ListCustomPropertiesLifecycleStateEnum = "UPDATING"
ListCustomPropertiesLifecycleStateDeleting ListCustomPropertiesLifecycleStateEnum = "DELETING"
ListCustomPropertiesLifecycleStateDeleted ListCustomPropertiesLifecycleStateEnum = "DELETED"
ListCustomPropertiesLifecycleStateFailed ListCustomPropertiesLifecycleStateEnum = "FAILED"
ListCustomPropertiesLifecycleStateMoving ListCustomPropertiesLifecycleStateEnum = "MOVING"
)
func GetListCustomPropertiesLifecycleStateEnumValues() []ListCustomPropertiesLifecycleStateEnum
GetListCustomPropertiesLifecycleStateEnumValues Enumerates the set of values for ListCustomPropertiesLifecycleStateEnum
func GetMappingListCustomPropertiesLifecycleStateEnum(val string) (ListCustomPropertiesLifecycleStateEnum, bool)
GetMappingListCustomPropertiesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListCustomPropertiesRequest wrapper for the ListCustomProperties operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListCustomProperties.go.html to see an example of how to use ListCustomPropertiesRequest.
type ListCustomPropertiesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// Return the custom properties which has specified data types
DataTypes []CustomPropertyDataTypeEnum `contributesTo:"query" name:"dataTypes" omitEmpty:"true" collectionFormat:"multi"`
// A filter to return only resources that match the entire type name given. The match is not case sensitive
TypeName []ListCustomPropertiesTypeNameEnum `contributesTo:"query" name:"typeName" omitEmpty:"true" collectionFormat:"multi"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListCustomPropertiesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Specifies the fields to return in a custom property summary response.
Fields []ListCustomPropertiesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListCustomPropertiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending
SortBy ListCustomPropertiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 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 ListCustomPropertiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCustomPropertiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCustomPropertiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCustomPropertiesRequest) String() string
func (request ListCustomPropertiesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCustomPropertiesResponse wrapper for the ListCustomProperties operation
type ListCustomPropertiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of CustomPropertyCollection instances
CustomPropertyCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCustomPropertiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCustomPropertiesResponse) String() string
ListCustomPropertiesSortByEnum Enum with underlying type: string
type ListCustomPropertiesSortByEnum string
Set of constants representing the allowable values for ListCustomPropertiesSortByEnum
const (
ListCustomPropertiesSortByDisplayname ListCustomPropertiesSortByEnum = "DISPLAYNAME"
ListCustomPropertiesSortByUsagecount ListCustomPropertiesSortByEnum = "USAGECOUNT"
)
func GetListCustomPropertiesSortByEnumValues() []ListCustomPropertiesSortByEnum
GetListCustomPropertiesSortByEnumValues Enumerates the set of values for ListCustomPropertiesSortByEnum
func GetMappingListCustomPropertiesSortByEnum(val string) (ListCustomPropertiesSortByEnum, bool)
GetMappingListCustomPropertiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCustomPropertiesSortOrderEnum Enum with underlying type: string
type ListCustomPropertiesSortOrderEnum string
Set of constants representing the allowable values for ListCustomPropertiesSortOrderEnum
const (
ListCustomPropertiesSortOrderAsc ListCustomPropertiesSortOrderEnum = "ASC"
ListCustomPropertiesSortOrderDesc ListCustomPropertiesSortOrderEnum = "DESC"
)
func GetListCustomPropertiesSortOrderEnumValues() []ListCustomPropertiesSortOrderEnum
GetListCustomPropertiesSortOrderEnumValues Enumerates the set of values for ListCustomPropertiesSortOrderEnum
func GetMappingListCustomPropertiesSortOrderEnum(val string) (ListCustomPropertiesSortOrderEnum, bool)
GetMappingListCustomPropertiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCustomPropertiesTypeNameEnum Enum with underlying type: string
type ListCustomPropertiesTypeNameEnum string
Set of constants representing the allowable values for ListCustomPropertiesTypeNameEnum
const (
ListCustomPropertiesTypeNameDataAsset ListCustomPropertiesTypeNameEnum = "DATA_ASSET"
ListCustomPropertiesTypeNameAutonomousDataWarehouse ListCustomPropertiesTypeNameEnum = "AUTONOMOUS_DATA_WAREHOUSE"
ListCustomPropertiesTypeNameHive ListCustomPropertiesTypeNameEnum = "HIVE"
ListCustomPropertiesTypeNameKafka ListCustomPropertiesTypeNameEnum = "KAFKA"
ListCustomPropertiesTypeNameMysql ListCustomPropertiesTypeNameEnum = "MYSQL"
ListCustomPropertiesTypeNameOracleObjectStorage ListCustomPropertiesTypeNameEnum = "ORACLE_OBJECT_STORAGE"
ListCustomPropertiesTypeNameAutonomousTransactionProcessing ListCustomPropertiesTypeNameEnum = "AUTONOMOUS_TRANSACTION_PROCESSING"
ListCustomPropertiesTypeNameOracle ListCustomPropertiesTypeNameEnum = "ORACLE"
ListCustomPropertiesTypeNamePostgresql ListCustomPropertiesTypeNameEnum = "POSTGRESQL"
ListCustomPropertiesTypeNameMicrosoftAzureSqlDatabase ListCustomPropertiesTypeNameEnum = "MICROSOFT_AZURE_SQL_DATABASE"
ListCustomPropertiesTypeNameMicrosoftSqlServer ListCustomPropertiesTypeNameEnum = "MICROSOFT_SQL_SERVER"
ListCustomPropertiesTypeNameIbmDb2 ListCustomPropertiesTypeNameEnum = "IBM_DB2"
ListCustomPropertiesTypeNameDataEntity ListCustomPropertiesTypeNameEnum = "DATA_ENTITY"
ListCustomPropertiesTypeNameLogicalEntity ListCustomPropertiesTypeNameEnum = "LOGICAL_ENTITY"
ListCustomPropertiesTypeNameTable ListCustomPropertiesTypeNameEnum = "TABLE"
ListCustomPropertiesTypeNameView ListCustomPropertiesTypeNameEnum = "VIEW"
ListCustomPropertiesTypeNameAttribute ListCustomPropertiesTypeNameEnum = "ATTRIBUTE"
ListCustomPropertiesTypeNameFolder ListCustomPropertiesTypeNameEnum = "FOLDER"
ListCustomPropertiesTypeNameOracleAnalyticsSubjectAreaColumn ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_SUBJECT_AREA_COLUMN"
ListCustomPropertiesTypeNameOracleAnalyticsLogicalColumn ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_LOGICAL_COLUMN"
ListCustomPropertiesTypeNameOracleAnalyticsPhysicalColumn ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_PHYSICAL_COLUMN"
ListCustomPropertiesTypeNameOracleAnalyticsAnalysisColumn ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_ANALYSIS_COLUMN"
ListCustomPropertiesTypeNameOracleAnalyticsServer ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_SERVER"
ListCustomPropertiesTypeNameOracleAnalyticsCloud ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_CLOUD"
ListCustomPropertiesTypeNameOracleAnalyticsSubjectArea ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_SUBJECT_AREA"
ListCustomPropertiesTypeNameOracleAnalyticsDashboard ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_DASHBOARD"
ListCustomPropertiesTypeNameOracleAnalyticsBusinessModel ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_BUSINESS_MODEL"
ListCustomPropertiesTypeNameOracleAnalyticsPhysicalDatabase ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_PHYSICAL_DATABASE"
ListCustomPropertiesTypeNameOracleAnalyticsPhysicalSchema ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_PHYSICAL_SCHEMA"
ListCustomPropertiesTypeNameOracleAnalyticsPresentationTable ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_PRESENTATION_TABLE"
ListCustomPropertiesTypeNameOracleAnalyticsLogicalTable ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_LOGICAL_TABLE"
ListCustomPropertiesTypeNameOracleAnalyticsPhysicalTable ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_PHYSICAL_TABLE"
ListCustomPropertiesTypeNameOracleAnalyticsAnalysis ListCustomPropertiesTypeNameEnum = "ORACLE_ANALYTICS_ANALYSIS"
ListCustomPropertiesTypeNameDatabaseSchema ListCustomPropertiesTypeNameEnum = "DATABASE_SCHEMA"
ListCustomPropertiesTypeNameTopic ListCustomPropertiesTypeNameEnum = "TOPIC"
ListCustomPropertiesTypeNameConnection ListCustomPropertiesTypeNameEnum = "CONNECTION"
ListCustomPropertiesTypeNameGlossary ListCustomPropertiesTypeNameEnum = "GLOSSARY"
ListCustomPropertiesTypeNameTerm ListCustomPropertiesTypeNameEnum = "TERM"
ListCustomPropertiesTypeNameCategory ListCustomPropertiesTypeNameEnum = "CATEGORY"
ListCustomPropertiesTypeNameFile ListCustomPropertiesTypeNameEnum = "FILE"
ListCustomPropertiesTypeNameBucket ListCustomPropertiesTypeNameEnum = "BUCKET"
ListCustomPropertiesTypeNameMessage ListCustomPropertiesTypeNameEnum = "MESSAGE"
ListCustomPropertiesTypeNameUnrecognizedFile ListCustomPropertiesTypeNameEnum = "UNRECOGNIZED_FILE"
)
func GetListCustomPropertiesTypeNameEnumValues() []ListCustomPropertiesTypeNameEnum
GetListCustomPropertiesTypeNameEnumValues Enumerates the set of values for ListCustomPropertiesTypeNameEnum
func GetMappingListCustomPropertiesTypeNameEnum(val string) (ListCustomPropertiesTypeNameEnum, bool)
GetMappingListCustomPropertiesTypeNameEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetTagsFieldsEnum Enum with underlying type: string
type ListDataAssetTagsFieldsEnum string
Set of constants representing the allowable values for ListDataAssetTagsFieldsEnum
const (
ListDataAssetTagsFieldsKey ListDataAssetTagsFieldsEnum = "key"
ListDataAssetTagsFieldsName ListDataAssetTagsFieldsEnum = "name"
ListDataAssetTagsFieldsTermkey ListDataAssetTagsFieldsEnum = "termKey"
ListDataAssetTagsFieldsTermpath ListDataAssetTagsFieldsEnum = "termPath"
ListDataAssetTagsFieldsTermdescription ListDataAssetTagsFieldsEnum = "termDescription"
ListDataAssetTagsFieldsLifecyclestate ListDataAssetTagsFieldsEnum = "lifecycleState"
ListDataAssetTagsFieldsTimecreated ListDataAssetTagsFieldsEnum = "timeCreated"
ListDataAssetTagsFieldsUri ListDataAssetTagsFieldsEnum = "uri"
ListDataAssetTagsFieldsGlossarykey ListDataAssetTagsFieldsEnum = "glossaryKey"
ListDataAssetTagsFieldsDataassetkey ListDataAssetTagsFieldsEnum = "dataAssetKey"
)
func GetListDataAssetTagsFieldsEnumValues() []ListDataAssetTagsFieldsEnum
GetListDataAssetTagsFieldsEnumValues Enumerates the set of values for ListDataAssetTagsFieldsEnum
func GetMappingListDataAssetTagsFieldsEnum(val string) (ListDataAssetTagsFieldsEnum, bool)
GetMappingListDataAssetTagsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetTagsLifecycleStateEnum Enum with underlying type: string
type ListDataAssetTagsLifecycleStateEnum string
Set of constants representing the allowable values for ListDataAssetTagsLifecycleStateEnum
const (
ListDataAssetTagsLifecycleStateCreating ListDataAssetTagsLifecycleStateEnum = "CREATING"
ListDataAssetTagsLifecycleStateActive ListDataAssetTagsLifecycleStateEnum = "ACTIVE"
ListDataAssetTagsLifecycleStateInactive ListDataAssetTagsLifecycleStateEnum = "INACTIVE"
ListDataAssetTagsLifecycleStateUpdating ListDataAssetTagsLifecycleStateEnum = "UPDATING"
ListDataAssetTagsLifecycleStateDeleting ListDataAssetTagsLifecycleStateEnum = "DELETING"
ListDataAssetTagsLifecycleStateDeleted ListDataAssetTagsLifecycleStateEnum = "DELETED"
ListDataAssetTagsLifecycleStateFailed ListDataAssetTagsLifecycleStateEnum = "FAILED"
ListDataAssetTagsLifecycleStateMoving ListDataAssetTagsLifecycleStateEnum = "MOVING"
)
func GetListDataAssetTagsLifecycleStateEnumValues() []ListDataAssetTagsLifecycleStateEnum
GetListDataAssetTagsLifecycleStateEnumValues Enumerates the set of values for ListDataAssetTagsLifecycleStateEnum
func GetMappingListDataAssetTagsLifecycleStateEnum(val string) (ListDataAssetTagsLifecycleStateEnum, bool)
GetMappingListDataAssetTagsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetTagsRequest wrapper for the ListDataAssetTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListDataAssetTags.go.html to see an example of how to use ListDataAssetTagsRequest.
type ListDataAssetTagsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Immutable resource name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListDataAssetTagsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique key of the related term.
TermKey *string `mandatory:"false" contributesTo:"query" name:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" contributesTo:"query" name:"termPath"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// Specifies the fields to return in a data asset tag summary response.
Fields []ListDataAssetTagsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListDataAssetTagsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDataAssetTagsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListDataAssetTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDataAssetTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDataAssetTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDataAssetTagsRequest) String() string
func (request ListDataAssetTagsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDataAssetTagsResponse wrapper for the ListDataAssetTags operation
type ListDataAssetTagsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DataAssetTagCollection instances
DataAssetTagCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDataAssetTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDataAssetTagsResponse) String() string
ListDataAssetTagsSortByEnum Enum with underlying type: string
type ListDataAssetTagsSortByEnum string
Set of constants representing the allowable values for ListDataAssetTagsSortByEnum
const (
ListDataAssetTagsSortByTimecreated ListDataAssetTagsSortByEnum = "TIMECREATED"
ListDataAssetTagsSortByDisplayname ListDataAssetTagsSortByEnum = "DISPLAYNAME"
)
func GetListDataAssetTagsSortByEnumValues() []ListDataAssetTagsSortByEnum
GetListDataAssetTagsSortByEnumValues Enumerates the set of values for ListDataAssetTagsSortByEnum
func GetMappingListDataAssetTagsSortByEnum(val string) (ListDataAssetTagsSortByEnum, bool)
GetMappingListDataAssetTagsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetTagsSortOrderEnum Enum with underlying type: string
type ListDataAssetTagsSortOrderEnum string
Set of constants representing the allowable values for ListDataAssetTagsSortOrderEnum
const (
ListDataAssetTagsSortOrderAsc ListDataAssetTagsSortOrderEnum = "ASC"
ListDataAssetTagsSortOrderDesc ListDataAssetTagsSortOrderEnum = "DESC"
)
func GetListDataAssetTagsSortOrderEnumValues() []ListDataAssetTagsSortOrderEnum
GetListDataAssetTagsSortOrderEnumValues Enumerates the set of values for ListDataAssetTagsSortOrderEnum
func GetMappingListDataAssetTagsSortOrderEnum(val string) (ListDataAssetTagsSortOrderEnum, bool)
GetMappingListDataAssetTagsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetsFieldsEnum Enum with underlying type: string
type ListDataAssetsFieldsEnum string
Set of constants representing the allowable values for ListDataAssetsFieldsEnum
const (
ListDataAssetsFieldsKey ListDataAssetsFieldsEnum = "key"
ListDataAssetsFieldsDisplayname ListDataAssetsFieldsEnum = "displayName"
ListDataAssetsFieldsDescription ListDataAssetsFieldsEnum = "description"
ListDataAssetsFieldsCatalogid ListDataAssetsFieldsEnum = "catalogId"
ListDataAssetsFieldsExternalkey ListDataAssetsFieldsEnum = "externalKey"
ListDataAssetsFieldsTypekey ListDataAssetsFieldsEnum = "typeKey"
ListDataAssetsFieldsLifecyclestate ListDataAssetsFieldsEnum = "lifecycleState"
ListDataAssetsFieldsTimecreated ListDataAssetsFieldsEnum = "timeCreated"
ListDataAssetsFieldsUri ListDataAssetsFieldsEnum = "uri"
)
func GetListDataAssetsFieldsEnumValues() []ListDataAssetsFieldsEnum
GetListDataAssetsFieldsEnumValues Enumerates the set of values for ListDataAssetsFieldsEnum
func GetMappingListDataAssetsFieldsEnum(val string) (ListDataAssetsFieldsEnum, bool)
GetMappingListDataAssetsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetsLifecycleStateEnum Enum with underlying type: string
type ListDataAssetsLifecycleStateEnum string
Set of constants representing the allowable values for ListDataAssetsLifecycleStateEnum
const (
ListDataAssetsLifecycleStateCreating ListDataAssetsLifecycleStateEnum = "CREATING"
ListDataAssetsLifecycleStateActive ListDataAssetsLifecycleStateEnum = "ACTIVE"
ListDataAssetsLifecycleStateInactive ListDataAssetsLifecycleStateEnum = "INACTIVE"
ListDataAssetsLifecycleStateUpdating ListDataAssetsLifecycleStateEnum = "UPDATING"
ListDataAssetsLifecycleStateDeleting ListDataAssetsLifecycleStateEnum = "DELETING"
ListDataAssetsLifecycleStateDeleted ListDataAssetsLifecycleStateEnum = "DELETED"
ListDataAssetsLifecycleStateFailed ListDataAssetsLifecycleStateEnum = "FAILED"
ListDataAssetsLifecycleStateMoving ListDataAssetsLifecycleStateEnum = "MOVING"
)
func GetListDataAssetsLifecycleStateEnumValues() []ListDataAssetsLifecycleStateEnum
GetListDataAssetsLifecycleStateEnumValues Enumerates the set of values for ListDataAssetsLifecycleStateEnum
func GetMappingListDataAssetsLifecycleStateEnum(val string) (ListDataAssetsLifecycleStateEnum, bool)
GetMappingListDataAssetsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetsRequest wrapper for the ListDataAssets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListDataAssets.go.html to see an example of how to use ListDataAssetsRequest.
type ListDataAssetsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListDataAssetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Unique external identifier of this resource in the external source system.
ExternalKey *string `mandatory:"false" contributesTo:"query" name:"externalKey"`
// The key of the object type.
TypeKey *string `mandatory:"false" contributesTo:"query" name:"typeKey"`
// Specifies the fields to return in a data asset summary response.
Fields []ListDataAssetsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListDataAssetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDataAssetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListDataAssetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDataAssetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDataAssetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDataAssetsRequest) String() string
func (request ListDataAssetsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDataAssetsResponse wrapper for the ListDataAssets operation
type ListDataAssetsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DataAssetCollection instances
DataAssetCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDataAssetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDataAssetsResponse) String() string
ListDataAssetsSortByEnum Enum with underlying type: string
type ListDataAssetsSortByEnum string
Set of constants representing the allowable values for ListDataAssetsSortByEnum
const (
ListDataAssetsSortByTimecreated ListDataAssetsSortByEnum = "TIMECREATED"
ListDataAssetsSortByDisplayname ListDataAssetsSortByEnum = "DISPLAYNAME"
)
func GetListDataAssetsSortByEnumValues() []ListDataAssetsSortByEnum
GetListDataAssetsSortByEnumValues Enumerates the set of values for ListDataAssetsSortByEnum
func GetMappingListDataAssetsSortByEnum(val string) (ListDataAssetsSortByEnum, bool)
GetMappingListDataAssetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataAssetsSortOrderEnum Enum with underlying type: string
type ListDataAssetsSortOrderEnum string
Set of constants representing the allowable values for ListDataAssetsSortOrderEnum
const (
ListDataAssetsSortOrderAsc ListDataAssetsSortOrderEnum = "ASC"
ListDataAssetsSortOrderDesc ListDataAssetsSortOrderEnum = "DESC"
)
func GetListDataAssetsSortOrderEnumValues() []ListDataAssetsSortOrderEnum
GetListDataAssetsSortOrderEnumValues Enumerates the set of values for ListDataAssetsSortOrderEnum
func GetMappingListDataAssetsSortOrderEnum(val string) (ListDataAssetsSortOrderEnum, bool)
GetMappingListDataAssetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDerivedLogicalEntitiesRequest wrapper for the ListDerivedLogicalEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListDerivedLogicalEntities.go.html to see an example of how to use ListDerivedLogicalEntitiesRequest.
type ListDerivedLogicalEntitiesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique pattern key.
PatternKey *string `mandatory:"true" contributesTo:"path" name:"patternKey"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListDerivedLogicalEntitiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDerivedLogicalEntitiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ListDerivedLogicalEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDerivedLogicalEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDerivedLogicalEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDerivedLogicalEntitiesRequest) String() string
func (request ListDerivedLogicalEntitiesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDerivedLogicalEntitiesResponse wrapper for the ListDerivedLogicalEntities operation
type ListDerivedLogicalEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EntityCollection instances
EntityCollection `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"`
}
func (response ListDerivedLogicalEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDerivedLogicalEntitiesResponse) String() string
ListDerivedLogicalEntitiesSortByEnum Enum with underlying type: string
type ListDerivedLogicalEntitiesSortByEnum string
Set of constants representing the allowable values for ListDerivedLogicalEntitiesSortByEnum
const (
ListDerivedLogicalEntitiesSortByTimecreated ListDerivedLogicalEntitiesSortByEnum = "TIMECREATED"
ListDerivedLogicalEntitiesSortByDisplayname ListDerivedLogicalEntitiesSortByEnum = "DISPLAYNAME"
)
func GetListDerivedLogicalEntitiesSortByEnumValues() []ListDerivedLogicalEntitiesSortByEnum
GetListDerivedLogicalEntitiesSortByEnumValues Enumerates the set of values for ListDerivedLogicalEntitiesSortByEnum
func GetMappingListDerivedLogicalEntitiesSortByEnum(val string) (ListDerivedLogicalEntitiesSortByEnum, bool)
GetMappingListDerivedLogicalEntitiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDerivedLogicalEntitiesSortOrderEnum Enum with underlying type: string
type ListDerivedLogicalEntitiesSortOrderEnum string
Set of constants representing the allowable values for ListDerivedLogicalEntitiesSortOrderEnum
const (
ListDerivedLogicalEntitiesSortOrderAsc ListDerivedLogicalEntitiesSortOrderEnum = "ASC"
ListDerivedLogicalEntitiesSortOrderDesc ListDerivedLogicalEntitiesSortOrderEnum = "DESC"
)
func GetListDerivedLogicalEntitiesSortOrderEnumValues() []ListDerivedLogicalEntitiesSortOrderEnum
GetListDerivedLogicalEntitiesSortOrderEnumValues Enumerates the set of values for ListDerivedLogicalEntitiesSortOrderEnum
func GetMappingListDerivedLogicalEntitiesSortOrderEnum(val string) (ListDerivedLogicalEntitiesSortOrderEnum, bool)
GetMappingListDerivedLogicalEntitiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntitiesFieldsEnum Enum with underlying type: string
type ListEntitiesFieldsEnum string
Set of constants representing the allowable values for ListEntitiesFieldsEnum
const (
ListEntitiesFieldsKey ListEntitiesFieldsEnum = "key"
ListEntitiesFieldsDisplayname ListEntitiesFieldsEnum = "displayName"
ListEntitiesFieldsDescription ListEntitiesFieldsEnum = "description"
ListEntitiesFieldsDataassetkey ListEntitiesFieldsEnum = "dataAssetKey"
ListEntitiesFieldsTimecreated ListEntitiesFieldsEnum = "timeCreated"
ListEntitiesFieldsTimeupdated ListEntitiesFieldsEnum = "timeUpdated"
ListEntitiesFieldsUpdatedbyid ListEntitiesFieldsEnum = "updatedById"
ListEntitiesFieldsLifecyclestate ListEntitiesFieldsEnum = "lifecycleState"
ListEntitiesFieldsFolderkey ListEntitiesFieldsEnum = "folderKey"
ListEntitiesFieldsFoldername ListEntitiesFieldsEnum = "folderName"
ListEntitiesFieldsExternalkey ListEntitiesFieldsEnum = "externalKey"
ListEntitiesFieldsPath ListEntitiesFieldsEnum = "path"
ListEntitiesFieldsUri ListEntitiesFieldsEnum = "uri"
)
func GetListEntitiesFieldsEnumValues() []ListEntitiesFieldsEnum
GetListEntitiesFieldsEnumValues Enumerates the set of values for ListEntitiesFieldsEnum
func GetMappingListEntitiesFieldsEnum(val string) (ListEntitiesFieldsEnum, bool)
GetMappingListEntitiesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntitiesHarvestStatusEnum Enum with underlying type: string
type ListEntitiesHarvestStatusEnum string
Set of constants representing the allowable values for ListEntitiesHarvestStatusEnum
const (
ListEntitiesHarvestStatusComplete ListEntitiesHarvestStatusEnum = "COMPLETE"
ListEntitiesHarvestStatusError ListEntitiesHarvestStatusEnum = "ERROR"
ListEntitiesHarvestStatusInProgress ListEntitiesHarvestStatusEnum = "IN_PROGRESS"
ListEntitiesHarvestStatusDeferred ListEntitiesHarvestStatusEnum = "DEFERRED"
)
func GetListEntitiesHarvestStatusEnumValues() []ListEntitiesHarvestStatusEnum
GetListEntitiesHarvestStatusEnumValues Enumerates the set of values for ListEntitiesHarvestStatusEnum
func GetMappingListEntitiesHarvestStatusEnum(val string) (ListEntitiesHarvestStatusEnum, bool)
GetMappingListEntitiesHarvestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntitiesLifecycleStateEnum Enum with underlying type: string
type ListEntitiesLifecycleStateEnum string
Set of constants representing the allowable values for ListEntitiesLifecycleStateEnum
const (
ListEntitiesLifecycleStateCreating ListEntitiesLifecycleStateEnum = "CREATING"
ListEntitiesLifecycleStateActive ListEntitiesLifecycleStateEnum = "ACTIVE"
ListEntitiesLifecycleStateInactive ListEntitiesLifecycleStateEnum = "INACTIVE"
ListEntitiesLifecycleStateUpdating ListEntitiesLifecycleStateEnum = "UPDATING"
ListEntitiesLifecycleStateDeleting ListEntitiesLifecycleStateEnum = "DELETING"
ListEntitiesLifecycleStateDeleted ListEntitiesLifecycleStateEnum = "DELETED"
ListEntitiesLifecycleStateFailed ListEntitiesLifecycleStateEnum = "FAILED"
ListEntitiesLifecycleStateMoving ListEntitiesLifecycleStateEnum = "MOVING"
)
func GetListEntitiesLifecycleStateEnumValues() []ListEntitiesLifecycleStateEnum
GetListEntitiesLifecycleStateEnumValues Enumerates the set of values for ListEntitiesLifecycleStateEnum
func GetMappingListEntitiesLifecycleStateEnum(val string) (ListEntitiesLifecycleStateEnum, bool)
GetMappingListEntitiesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntitiesRequest wrapper for the ListEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListEntities.go.html to see an example of how to use ListEntitiesRequest.
type ListEntitiesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the entire business name given. The match is not case sensitive.
BusinessName *string `mandatory:"false" contributesTo:"query" name:"businessName"`
// A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.
// For Example : /folders?displayOrBusinessNameContains=Cu.*
// The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayOrBusinessNameContains *string `mandatory:"false" contributesTo:"query" name:"displayOrBusinessNameContains"`
// The key of the object type.
TypeKey *string `mandatory:"false" contributesTo:"query" name:"typeKey"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListEntitiesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Unique external identifier of this resource in the external source system.
ExternalKey *string `mandatory:"false" contributesTo:"query" name:"externalKey"`
// Unique pattern key.
PatternKey *string `mandatory:"false" contributesTo:"query" name:"patternKey"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeExternal"`
// Time that the resource's status was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStatusUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeStatusUpdated"`
// Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
IsLogical *bool `mandatory:"false" contributesTo:"query" name:"isLogical"`
// Identifies if an object is a sub object (partition) of a physical or materialized parent object.
IsPartition *bool `mandatory:"false" contributesTo:"query" name:"isPartition"`
// Key of the associated folder.
FolderKey *string `mandatory:"false" contributesTo:"query" name:"folderKey"`
// Full path of the resource for resources that support paths.
Path *string `mandatory:"false" contributesTo:"query" name:"path"`
// Harvest status of the harvestable resource as updated by the harvest process.
HarvestStatus ListEntitiesHarvestStatusEnum `mandatory:"false" contributesTo:"query" name:"harvestStatus" omitEmpty:"true"`
// Key of the last harvest process to update this resource.
LastJobKey *string `mandatory:"false" contributesTo:"query" name:"lastJobKey"`
// Specifies the fields to return in an entity summary response.
Fields []ListEntitiesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.
// Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.
SortBy ListEntitiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListEntitiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only process entities.
IsProcess *bool `mandatory:"false" contributesTo:"query" name:"isProcess"`
// 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 ListEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEntitiesRequest) String() string
func (request ListEntitiesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListEntitiesResponse wrapper for the ListEntities operation
type ListEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EntityCollection instances
EntityCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEntitiesResponse) String() string
ListEntitiesSortByEnum Enum with underlying type: string
type ListEntitiesSortByEnum string
Set of constants representing the allowable values for ListEntitiesSortByEnum
const (
ListEntitiesSortByTimecreated ListEntitiesSortByEnum = "TIMECREATED"
ListEntitiesSortByDisplayname ListEntitiesSortByEnum = "DISPLAYNAME"
ListEntitiesSortByDisplayorbusinessname ListEntitiesSortByEnum = "DISPLAYORBUSINESSNAME"
)
func GetListEntitiesSortByEnumValues() []ListEntitiesSortByEnum
GetListEntitiesSortByEnumValues Enumerates the set of values for ListEntitiesSortByEnum
func GetMappingListEntitiesSortByEnum(val string) (ListEntitiesSortByEnum, bool)
GetMappingListEntitiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntitiesSortOrderEnum Enum with underlying type: string
type ListEntitiesSortOrderEnum string
Set of constants representing the allowable values for ListEntitiesSortOrderEnum
const (
ListEntitiesSortOrderAsc ListEntitiesSortOrderEnum = "ASC"
ListEntitiesSortOrderDesc ListEntitiesSortOrderEnum = "DESC"
)
func GetListEntitiesSortOrderEnumValues() []ListEntitiesSortOrderEnum
GetListEntitiesSortOrderEnumValues Enumerates the set of values for ListEntitiesSortOrderEnum
func GetMappingListEntitiesSortOrderEnum(val string) (ListEntitiesSortOrderEnum, bool)
GetMappingListEntitiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntityTagsFieldsEnum Enum with underlying type: string
type ListEntityTagsFieldsEnum string
Set of constants representing the allowable values for ListEntityTagsFieldsEnum
const (
ListEntityTagsFieldsKey ListEntityTagsFieldsEnum = "key"
ListEntityTagsFieldsName ListEntityTagsFieldsEnum = "name"
ListEntityTagsFieldsTermkey ListEntityTagsFieldsEnum = "termKey"
ListEntityTagsFieldsTermpath ListEntityTagsFieldsEnum = "termPath"
ListEntityTagsFieldsTermdescription ListEntityTagsFieldsEnum = "termDescription"
ListEntityTagsFieldsLifecyclestate ListEntityTagsFieldsEnum = "lifecycleState"
ListEntityTagsFieldsTimecreated ListEntityTagsFieldsEnum = "timeCreated"
ListEntityTagsFieldsUri ListEntityTagsFieldsEnum = "uri"
ListEntityTagsFieldsGlossarykey ListEntityTagsFieldsEnum = "glossaryKey"
ListEntityTagsFieldsEntitykey ListEntityTagsFieldsEnum = "entityKey"
)
func GetListEntityTagsFieldsEnumValues() []ListEntityTagsFieldsEnum
GetListEntityTagsFieldsEnumValues Enumerates the set of values for ListEntityTagsFieldsEnum
func GetMappingListEntityTagsFieldsEnum(val string) (ListEntityTagsFieldsEnum, bool)
GetMappingListEntityTagsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntityTagsLifecycleStateEnum Enum with underlying type: string
type ListEntityTagsLifecycleStateEnum string
Set of constants representing the allowable values for ListEntityTagsLifecycleStateEnum
const (
ListEntityTagsLifecycleStateCreating ListEntityTagsLifecycleStateEnum = "CREATING"
ListEntityTagsLifecycleStateActive ListEntityTagsLifecycleStateEnum = "ACTIVE"
ListEntityTagsLifecycleStateInactive ListEntityTagsLifecycleStateEnum = "INACTIVE"
ListEntityTagsLifecycleStateUpdating ListEntityTagsLifecycleStateEnum = "UPDATING"
ListEntityTagsLifecycleStateDeleting ListEntityTagsLifecycleStateEnum = "DELETING"
ListEntityTagsLifecycleStateDeleted ListEntityTagsLifecycleStateEnum = "DELETED"
ListEntityTagsLifecycleStateFailed ListEntityTagsLifecycleStateEnum = "FAILED"
ListEntityTagsLifecycleStateMoving ListEntityTagsLifecycleStateEnum = "MOVING"
)
func GetListEntityTagsLifecycleStateEnumValues() []ListEntityTagsLifecycleStateEnum
GetListEntityTagsLifecycleStateEnumValues Enumerates the set of values for ListEntityTagsLifecycleStateEnum
func GetMappingListEntityTagsLifecycleStateEnum(val string) (ListEntityTagsLifecycleStateEnum, bool)
GetMappingListEntityTagsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntityTagsRequest wrapper for the ListEntityTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListEntityTags.go.html to see an example of how to use ListEntityTagsRequest.
type ListEntityTagsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Immutable resource name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListEntityTagsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique key of the related term.
TermKey *string `mandatory:"false" contributesTo:"query" name:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" contributesTo:"query" name:"termPath"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// Specifies the fields to return in an entity tag summary response.
Fields []ListEntityTagsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListEntityTagsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListEntityTagsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListEntityTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEntityTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEntityTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEntityTagsRequest) String() string
func (request ListEntityTagsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListEntityTagsResponse wrapper for the ListEntityTags operation
type ListEntityTagsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EntityTagCollection instances
EntityTagCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListEntityTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEntityTagsResponse) String() string
ListEntityTagsSortByEnum Enum with underlying type: string
type ListEntityTagsSortByEnum string
Set of constants representing the allowable values for ListEntityTagsSortByEnum
const (
ListEntityTagsSortByTimecreated ListEntityTagsSortByEnum = "TIMECREATED"
ListEntityTagsSortByDisplayname ListEntityTagsSortByEnum = "DISPLAYNAME"
)
func GetListEntityTagsSortByEnumValues() []ListEntityTagsSortByEnum
GetListEntityTagsSortByEnumValues Enumerates the set of values for ListEntityTagsSortByEnum
func GetMappingListEntityTagsSortByEnum(val string) (ListEntityTagsSortByEnum, bool)
GetMappingListEntityTagsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEntityTagsSortOrderEnum Enum with underlying type: string
type ListEntityTagsSortOrderEnum string
Set of constants representing the allowable values for ListEntityTagsSortOrderEnum
const (
ListEntityTagsSortOrderAsc ListEntityTagsSortOrderEnum = "ASC"
ListEntityTagsSortOrderDesc ListEntityTagsSortOrderEnum = "DESC"
)
func GetListEntityTagsSortOrderEnumValues() []ListEntityTagsSortOrderEnum
GetListEntityTagsSortOrderEnumValues Enumerates the set of values for ListEntityTagsSortOrderEnum
func GetMappingListEntityTagsSortOrderEnum(val string) (ListEntityTagsSortOrderEnum, bool)
GetMappingListEntityTagsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFolderTagsFieldsEnum Enum with underlying type: string
type ListFolderTagsFieldsEnum string
Set of constants representing the allowable values for ListFolderTagsFieldsEnum
const (
ListFolderTagsFieldsKey ListFolderTagsFieldsEnum = "key"
ListFolderTagsFieldsName ListFolderTagsFieldsEnum = "name"
ListFolderTagsFieldsTermkey ListFolderTagsFieldsEnum = "termKey"
ListFolderTagsFieldsTermpath ListFolderTagsFieldsEnum = "termPath"
ListFolderTagsFieldsTermdescription ListFolderTagsFieldsEnum = "termDescription"
ListFolderTagsFieldsLifecyclestate ListFolderTagsFieldsEnum = "lifecycleState"
ListFolderTagsFieldsTimecreated ListFolderTagsFieldsEnum = "timeCreated"
ListFolderTagsFieldsUri ListFolderTagsFieldsEnum = "uri"
ListFolderTagsFieldsGlossarykey ListFolderTagsFieldsEnum = "glossaryKey"
ListFolderTagsFieldsFolderkey ListFolderTagsFieldsEnum = "folderKey"
)
func GetListFolderTagsFieldsEnumValues() []ListFolderTagsFieldsEnum
GetListFolderTagsFieldsEnumValues Enumerates the set of values for ListFolderTagsFieldsEnum
func GetMappingListFolderTagsFieldsEnum(val string) (ListFolderTagsFieldsEnum, bool)
GetMappingListFolderTagsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListFolderTagsLifecycleStateEnum Enum with underlying type: string
type ListFolderTagsLifecycleStateEnum string
Set of constants representing the allowable values for ListFolderTagsLifecycleStateEnum
const (
ListFolderTagsLifecycleStateCreating ListFolderTagsLifecycleStateEnum = "CREATING"
ListFolderTagsLifecycleStateActive ListFolderTagsLifecycleStateEnum = "ACTIVE"
ListFolderTagsLifecycleStateInactive ListFolderTagsLifecycleStateEnum = "INACTIVE"
ListFolderTagsLifecycleStateUpdating ListFolderTagsLifecycleStateEnum = "UPDATING"
ListFolderTagsLifecycleStateDeleting ListFolderTagsLifecycleStateEnum = "DELETING"
ListFolderTagsLifecycleStateDeleted ListFolderTagsLifecycleStateEnum = "DELETED"
ListFolderTagsLifecycleStateFailed ListFolderTagsLifecycleStateEnum = "FAILED"
ListFolderTagsLifecycleStateMoving ListFolderTagsLifecycleStateEnum = "MOVING"
)
func GetListFolderTagsLifecycleStateEnumValues() []ListFolderTagsLifecycleStateEnum
GetListFolderTagsLifecycleStateEnumValues Enumerates the set of values for ListFolderTagsLifecycleStateEnum
func GetMappingListFolderTagsLifecycleStateEnum(val string) (ListFolderTagsLifecycleStateEnum, bool)
GetMappingListFolderTagsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListFolderTagsRequest wrapper for the ListFolderTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListFolderTags.go.html to see an example of how to use ListFolderTagsRequest.
type ListFolderTagsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique folder key.
FolderKey *string `mandatory:"true" contributesTo:"path" name:"folderKey"`
// Immutable resource name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListFolderTagsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique key of the related term.
TermKey *string `mandatory:"false" contributesTo:"query" name:"termKey"`
// Path of the related term.
TermPath *string `mandatory:"false" contributesTo:"query" name:"termPath"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// Specifies the fields to return in a folder tag summary response.
Fields []ListFolderTagsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListFolderTagsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListFolderTagsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListFolderTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFolderTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFolderTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFolderTagsRequest) String() string
func (request ListFolderTagsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListFolderTagsResponse wrapper for the ListFolderTags operation
type ListFolderTagsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of FolderTagCollection instances
FolderTagCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListFolderTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFolderTagsResponse) String() string
ListFolderTagsSortByEnum Enum with underlying type: string
type ListFolderTagsSortByEnum string
Set of constants representing the allowable values for ListFolderTagsSortByEnum
const (
ListFolderTagsSortByTimecreated ListFolderTagsSortByEnum = "TIMECREATED"
ListFolderTagsSortByDisplayname ListFolderTagsSortByEnum = "DISPLAYNAME"
)
func GetListFolderTagsSortByEnumValues() []ListFolderTagsSortByEnum
GetListFolderTagsSortByEnumValues Enumerates the set of values for ListFolderTagsSortByEnum
func GetMappingListFolderTagsSortByEnum(val string) (ListFolderTagsSortByEnum, bool)
GetMappingListFolderTagsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListFolderTagsSortOrderEnum Enum with underlying type: string
type ListFolderTagsSortOrderEnum string
Set of constants representing the allowable values for ListFolderTagsSortOrderEnum
const (
ListFolderTagsSortOrderAsc ListFolderTagsSortOrderEnum = "ASC"
ListFolderTagsSortOrderDesc ListFolderTagsSortOrderEnum = "DESC"
)
func GetListFolderTagsSortOrderEnumValues() []ListFolderTagsSortOrderEnum
GetListFolderTagsSortOrderEnumValues Enumerates the set of values for ListFolderTagsSortOrderEnum
func GetMappingListFolderTagsSortOrderEnum(val string) (ListFolderTagsSortOrderEnum, bool)
GetMappingListFolderTagsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFoldersFieldsEnum Enum with underlying type: string
type ListFoldersFieldsEnum string
Set of constants representing the allowable values for ListFoldersFieldsEnum
const (
ListFoldersFieldsKey ListFoldersFieldsEnum = "key"
ListFoldersFieldsDisplayname ListFoldersFieldsEnum = "displayName"
ListFoldersFieldsDescription ListFoldersFieldsEnum = "description"
ListFoldersFieldsParentfolderkey ListFoldersFieldsEnum = "parentFolderKey"
ListFoldersFieldsPath ListFoldersFieldsEnum = "path"
ListFoldersFieldsDataassetkey ListFoldersFieldsEnum = "dataAssetKey"
ListFoldersFieldsExternalkey ListFoldersFieldsEnum = "externalKey"
ListFoldersFieldsTimeexternal ListFoldersFieldsEnum = "timeExternal"
ListFoldersFieldsTimecreated ListFoldersFieldsEnum = "timeCreated"
ListFoldersFieldsLifecyclestate ListFoldersFieldsEnum = "lifecycleState"
ListFoldersFieldsUri ListFoldersFieldsEnum = "uri"
)
func GetListFoldersFieldsEnumValues() []ListFoldersFieldsEnum
GetListFoldersFieldsEnumValues Enumerates the set of values for ListFoldersFieldsEnum
func GetMappingListFoldersFieldsEnum(val string) (ListFoldersFieldsEnum, bool)
GetMappingListFoldersFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListFoldersHarvestStatusEnum Enum with underlying type: string
type ListFoldersHarvestStatusEnum string
Set of constants representing the allowable values for ListFoldersHarvestStatusEnum
const (
ListFoldersHarvestStatusComplete ListFoldersHarvestStatusEnum = "COMPLETE"
ListFoldersHarvestStatusError ListFoldersHarvestStatusEnum = "ERROR"
ListFoldersHarvestStatusInProgress ListFoldersHarvestStatusEnum = "IN_PROGRESS"
ListFoldersHarvestStatusDeferred ListFoldersHarvestStatusEnum = "DEFERRED"
)
func GetListFoldersHarvestStatusEnumValues() []ListFoldersHarvestStatusEnum
GetListFoldersHarvestStatusEnumValues Enumerates the set of values for ListFoldersHarvestStatusEnum
func GetMappingListFoldersHarvestStatusEnum(val string) (ListFoldersHarvestStatusEnum, bool)
GetMappingListFoldersHarvestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListFoldersLifecycleStateEnum Enum with underlying type: string
type ListFoldersLifecycleStateEnum string
Set of constants representing the allowable values for ListFoldersLifecycleStateEnum
const (
ListFoldersLifecycleStateCreating ListFoldersLifecycleStateEnum = "CREATING"
ListFoldersLifecycleStateActive ListFoldersLifecycleStateEnum = "ACTIVE"
ListFoldersLifecycleStateInactive ListFoldersLifecycleStateEnum = "INACTIVE"
ListFoldersLifecycleStateUpdating ListFoldersLifecycleStateEnum = "UPDATING"
ListFoldersLifecycleStateDeleting ListFoldersLifecycleStateEnum = "DELETING"
ListFoldersLifecycleStateDeleted ListFoldersLifecycleStateEnum = "DELETED"
ListFoldersLifecycleStateFailed ListFoldersLifecycleStateEnum = "FAILED"
ListFoldersLifecycleStateMoving ListFoldersLifecycleStateEnum = "MOVING"
)
func GetListFoldersLifecycleStateEnumValues() []ListFoldersLifecycleStateEnum
GetListFoldersLifecycleStateEnumValues Enumerates the set of values for ListFoldersLifecycleStateEnum
func GetMappingListFoldersLifecycleStateEnum(val string) (ListFoldersLifecycleStateEnum, bool)
GetMappingListFoldersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListFoldersRequest wrapper for the ListFolders operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListFolders.go.html to see an example of how to use ListFoldersRequest.
type ListFoldersRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the entire business name given. The match is not case sensitive.
BusinessName *string `mandatory:"false" contributesTo:"query" name:"businessName"`
// A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.
// For Example : /folders?displayOrBusinessNameContains=Cu.*
// The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayOrBusinessNameContains *string `mandatory:"false" contributesTo:"query" name:"displayOrBusinessNameContains"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListFoldersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique folder key.
ParentFolderKey *string `mandatory:"false" contributesTo:"query" name:"parentFolderKey"`
// Full path of the resource for resources that support paths.
Path *string `mandatory:"false" contributesTo:"query" name:"path"`
// Unique external identifier of this resource in the external source system.
ExternalKey *string `mandatory:"false" contributesTo:"query" name:"externalKey"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Harvest status of the harvestable resource as updated by the harvest process.
HarvestStatus ListFoldersHarvestStatusEnum `mandatory:"false" contributesTo:"query" name:"harvestStatus" omitEmpty:"true"`
// Key of the last harvest process to update this resource.
LastJobKey *string `mandatory:"false" contributesTo:"query" name:"lastJobKey"`
// Specifies the fields to return in a folder summary response.
Fields []ListFoldersFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The key of the object type.
TypeKey *string `mandatory:"false" contributesTo:"query" name:"typeKey"`
// The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.
// Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.
SortBy ListFoldersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListFoldersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListFoldersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFoldersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFoldersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFoldersRequest) String() string
func (request ListFoldersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListFoldersResponse wrapper for the ListFolders operation
type ListFoldersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of FolderCollection instances
FolderCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListFoldersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFoldersResponse) String() string
ListFoldersSortByEnum Enum with underlying type: string
type ListFoldersSortByEnum string
Set of constants representing the allowable values for ListFoldersSortByEnum
const (
ListFoldersSortByTimecreated ListFoldersSortByEnum = "TIMECREATED"
ListFoldersSortByDisplayname ListFoldersSortByEnum = "DISPLAYNAME"
ListFoldersSortByDisplayorbusinessname ListFoldersSortByEnum = "DISPLAYORBUSINESSNAME"
)
func GetListFoldersSortByEnumValues() []ListFoldersSortByEnum
GetListFoldersSortByEnumValues Enumerates the set of values for ListFoldersSortByEnum
func GetMappingListFoldersSortByEnum(val string) (ListFoldersSortByEnum, bool)
GetMappingListFoldersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListFoldersSortOrderEnum Enum with underlying type: string
type ListFoldersSortOrderEnum string
Set of constants representing the allowable values for ListFoldersSortOrderEnum
const (
ListFoldersSortOrderAsc ListFoldersSortOrderEnum = "ASC"
ListFoldersSortOrderDesc ListFoldersSortOrderEnum = "DESC"
)
func GetListFoldersSortOrderEnumValues() []ListFoldersSortOrderEnum
GetListFoldersSortOrderEnumValues Enumerates the set of values for ListFoldersSortOrderEnum
func GetMappingListFoldersSortOrderEnum(val string) (ListFoldersSortOrderEnum, bool)
GetMappingListFoldersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGlossariesFieldsEnum Enum with underlying type: string
type ListGlossariesFieldsEnum string
Set of constants representing the allowable values for ListGlossariesFieldsEnum
const (
ListGlossariesFieldsKey ListGlossariesFieldsEnum = "key"
ListGlossariesFieldsDisplayname ListGlossariesFieldsEnum = "displayName"
ListGlossariesFieldsDescription ListGlossariesFieldsEnum = "description"
ListGlossariesFieldsCatalogid ListGlossariesFieldsEnum = "catalogId"
ListGlossariesFieldsLifecyclestate ListGlossariesFieldsEnum = "lifecycleState"
ListGlossariesFieldsTimecreated ListGlossariesFieldsEnum = "timeCreated"
ListGlossariesFieldsUri ListGlossariesFieldsEnum = "uri"
ListGlossariesFieldsWorkflowstatus ListGlossariesFieldsEnum = "workflowStatus"
)
func GetListGlossariesFieldsEnumValues() []ListGlossariesFieldsEnum
GetListGlossariesFieldsEnumValues Enumerates the set of values for ListGlossariesFieldsEnum
func GetMappingListGlossariesFieldsEnum(val string) (ListGlossariesFieldsEnum, bool)
GetMappingListGlossariesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListGlossariesLifecycleStateEnum Enum with underlying type: string
type ListGlossariesLifecycleStateEnum string
Set of constants representing the allowable values for ListGlossariesLifecycleStateEnum
const (
ListGlossariesLifecycleStateCreating ListGlossariesLifecycleStateEnum = "CREATING"
ListGlossariesLifecycleStateActive ListGlossariesLifecycleStateEnum = "ACTIVE"
ListGlossariesLifecycleStateInactive ListGlossariesLifecycleStateEnum = "INACTIVE"
ListGlossariesLifecycleStateUpdating ListGlossariesLifecycleStateEnum = "UPDATING"
ListGlossariesLifecycleStateDeleting ListGlossariesLifecycleStateEnum = "DELETING"
ListGlossariesLifecycleStateDeleted ListGlossariesLifecycleStateEnum = "DELETED"
ListGlossariesLifecycleStateFailed ListGlossariesLifecycleStateEnum = "FAILED"
ListGlossariesLifecycleStateMoving ListGlossariesLifecycleStateEnum = "MOVING"
)
func GetListGlossariesLifecycleStateEnumValues() []ListGlossariesLifecycleStateEnum
GetListGlossariesLifecycleStateEnumValues Enumerates the set of values for ListGlossariesLifecycleStateEnum
func GetMappingListGlossariesLifecycleStateEnum(val string) (ListGlossariesLifecycleStateEnum, bool)
GetMappingListGlossariesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListGlossariesRequest wrapper for the ListGlossaries operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListGlossaries.go.html to see an example of how to use ListGlossariesRequest.
type ListGlossariesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListGlossariesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Specifies the fields to return in a glossary summary response.
Fields []ListGlossariesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListGlossariesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListGlossariesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListGlossariesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGlossariesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGlossariesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGlossariesRequest) String() string
func (request ListGlossariesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListGlossariesResponse wrapper for the ListGlossaries operation
type ListGlossariesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GlossaryCollection instances
GlossaryCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListGlossariesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGlossariesResponse) String() string
ListGlossariesSortByEnum Enum with underlying type: string
type ListGlossariesSortByEnum string
Set of constants representing the allowable values for ListGlossariesSortByEnum
const (
ListGlossariesSortByTimecreated ListGlossariesSortByEnum = "TIMECREATED"
ListGlossariesSortByDisplayname ListGlossariesSortByEnum = "DISPLAYNAME"
)
func GetListGlossariesSortByEnumValues() []ListGlossariesSortByEnum
GetListGlossariesSortByEnumValues Enumerates the set of values for ListGlossariesSortByEnum
func GetMappingListGlossariesSortByEnum(val string) (ListGlossariesSortByEnum, bool)
GetMappingListGlossariesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGlossariesSortOrderEnum Enum with underlying type: string
type ListGlossariesSortOrderEnum string
Set of constants representing the allowable values for ListGlossariesSortOrderEnum
const (
ListGlossariesSortOrderAsc ListGlossariesSortOrderEnum = "ASC"
ListGlossariesSortOrderDesc ListGlossariesSortOrderEnum = "DESC"
)
func GetListGlossariesSortOrderEnumValues() []ListGlossariesSortOrderEnum
GetListGlossariesSortOrderEnumValues Enumerates the set of values for ListGlossariesSortOrderEnum
func GetMappingListGlossariesSortOrderEnum(val string) (ListGlossariesSortOrderEnum, bool)
GetMappingListGlossariesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobDefinitionsFieldsEnum Enum with underlying type: string
type ListJobDefinitionsFieldsEnum string
Set of constants representing the allowable values for ListJobDefinitionsFieldsEnum
const (
ListJobDefinitionsFieldsKey ListJobDefinitionsFieldsEnum = "key"
ListJobDefinitionsFieldsDisplayname ListJobDefinitionsFieldsEnum = "displayName"
ListJobDefinitionsFieldsDescription ListJobDefinitionsFieldsEnum = "description"
ListJobDefinitionsFieldsCatalogid ListJobDefinitionsFieldsEnum = "catalogId"
ListJobDefinitionsFieldsJobtype ListJobDefinitionsFieldsEnum = "jobType"
ListJobDefinitionsFieldsConnectionkey ListJobDefinitionsFieldsEnum = "connectionKey"
ListJobDefinitionsFieldsLifecyclestate ListJobDefinitionsFieldsEnum = "lifecycleState"
ListJobDefinitionsFieldsTimecreated ListJobDefinitionsFieldsEnum = "timeCreated"
ListJobDefinitionsFieldsIssampledataextracted ListJobDefinitionsFieldsEnum = "isSampleDataExtracted"
ListJobDefinitionsFieldsUri ListJobDefinitionsFieldsEnum = "uri"
ListJobDefinitionsFieldsTimelatestexecutionstarted ListJobDefinitionsFieldsEnum = "timeLatestExecutionStarted"
ListJobDefinitionsFieldsTimelatestexecutionended ListJobDefinitionsFieldsEnum = "timeLatestExecutionEnded"
ListJobDefinitionsFieldsJobexecutionstate ListJobDefinitionsFieldsEnum = "jobExecutionState"
ListJobDefinitionsFieldsScheduletype ListJobDefinitionsFieldsEnum = "scheduleType"
)
func GetListJobDefinitionsFieldsEnumValues() []ListJobDefinitionsFieldsEnum
GetListJobDefinitionsFieldsEnumValues Enumerates the set of values for ListJobDefinitionsFieldsEnum
func GetMappingListJobDefinitionsFieldsEnum(val string) (ListJobDefinitionsFieldsEnum, bool)
GetMappingListJobDefinitionsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobDefinitionsJobExecutionStateEnum Enum with underlying type: string
type ListJobDefinitionsJobExecutionStateEnum string
Set of constants representing the allowable values for ListJobDefinitionsJobExecutionStateEnum
const (
ListJobDefinitionsJobExecutionStateCreated ListJobDefinitionsJobExecutionStateEnum = "CREATED"
ListJobDefinitionsJobExecutionStateInProgress ListJobDefinitionsJobExecutionStateEnum = "IN_PROGRESS"
ListJobDefinitionsJobExecutionStateInactive ListJobDefinitionsJobExecutionStateEnum = "INACTIVE"
ListJobDefinitionsJobExecutionStateFailed ListJobDefinitionsJobExecutionStateEnum = "FAILED"
ListJobDefinitionsJobExecutionStateSucceeded ListJobDefinitionsJobExecutionStateEnum = "SUCCEEDED"
ListJobDefinitionsJobExecutionStateCanceled ListJobDefinitionsJobExecutionStateEnum = "CANCELED"
ListJobDefinitionsJobExecutionStateSucceededWithWarnings ListJobDefinitionsJobExecutionStateEnum = "SUCCEEDED_WITH_WARNINGS"
)
func GetListJobDefinitionsJobExecutionStateEnumValues() []ListJobDefinitionsJobExecutionStateEnum
GetListJobDefinitionsJobExecutionStateEnumValues Enumerates the set of values for ListJobDefinitionsJobExecutionStateEnum
func GetMappingListJobDefinitionsJobExecutionStateEnum(val string) (ListJobDefinitionsJobExecutionStateEnum, bool)
GetMappingListJobDefinitionsJobExecutionStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobDefinitionsJobTypeEnum Enum with underlying type: string
type ListJobDefinitionsJobTypeEnum string
Set of constants representing the allowable values for ListJobDefinitionsJobTypeEnum
const (
ListJobDefinitionsJobTypeHarvest ListJobDefinitionsJobTypeEnum = "HARVEST"
ListJobDefinitionsJobTypeProfiling ListJobDefinitionsJobTypeEnum = "PROFILING"
ListJobDefinitionsJobTypeSampling ListJobDefinitionsJobTypeEnum = "SAMPLING"
ListJobDefinitionsJobTypePreview ListJobDefinitionsJobTypeEnum = "PREVIEW"
ListJobDefinitionsJobTypeImport ListJobDefinitionsJobTypeEnum = "IMPORT"
ListJobDefinitionsJobTypeExport ListJobDefinitionsJobTypeEnum = "EXPORT"
ListJobDefinitionsJobTypeImportGlossary ListJobDefinitionsJobTypeEnum = "IMPORT_GLOSSARY"
ListJobDefinitionsJobTypeExportGlossary ListJobDefinitionsJobTypeEnum = "EXPORT_GLOSSARY"
ListJobDefinitionsJobTypeInternal ListJobDefinitionsJobTypeEnum = "INTERNAL"
ListJobDefinitionsJobTypePurge ListJobDefinitionsJobTypeEnum = "PURGE"
ListJobDefinitionsJobTypeImmediate ListJobDefinitionsJobTypeEnum = "IMMEDIATE"
ListJobDefinitionsJobTypeScheduled ListJobDefinitionsJobTypeEnum = "SCHEDULED"
ListJobDefinitionsJobTypeImmediateExecution ListJobDefinitionsJobTypeEnum = "IMMEDIATE_EXECUTION"
ListJobDefinitionsJobTypeScheduledExecution ListJobDefinitionsJobTypeEnum = "SCHEDULED_EXECUTION"
ListJobDefinitionsJobTypeScheduledExecutionInstance ListJobDefinitionsJobTypeEnum = "SCHEDULED_EXECUTION_INSTANCE"
ListJobDefinitionsJobTypeAsyncDelete ListJobDefinitionsJobTypeEnum = "ASYNC_DELETE"
ListJobDefinitionsJobTypeImportDataAsset ListJobDefinitionsJobTypeEnum = "IMPORT_DATA_ASSET"
ListJobDefinitionsJobTypeCreateScanProxy ListJobDefinitionsJobTypeEnum = "CREATE_SCAN_PROXY"
ListJobDefinitionsJobTypeAsyncExportGlossary ListJobDefinitionsJobTypeEnum = "ASYNC_EXPORT_GLOSSARY"
ListJobDefinitionsJobTypeAsyncExportDataAsset ListJobDefinitionsJobTypeEnum = "ASYNC_EXPORT_DATA_ASSET"
)
func GetListJobDefinitionsJobTypeEnumValues() []ListJobDefinitionsJobTypeEnum
GetListJobDefinitionsJobTypeEnumValues Enumerates the set of values for ListJobDefinitionsJobTypeEnum
func GetMappingListJobDefinitionsJobTypeEnum(val string) (ListJobDefinitionsJobTypeEnum, bool)
GetMappingListJobDefinitionsJobTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobDefinitionsLifecycleStateEnum Enum with underlying type: string
type ListJobDefinitionsLifecycleStateEnum string
Set of constants representing the allowable values for ListJobDefinitionsLifecycleStateEnum
const (
ListJobDefinitionsLifecycleStateCreating ListJobDefinitionsLifecycleStateEnum = "CREATING"
ListJobDefinitionsLifecycleStateActive ListJobDefinitionsLifecycleStateEnum = "ACTIVE"
ListJobDefinitionsLifecycleStateInactive ListJobDefinitionsLifecycleStateEnum = "INACTIVE"
ListJobDefinitionsLifecycleStateUpdating ListJobDefinitionsLifecycleStateEnum = "UPDATING"
ListJobDefinitionsLifecycleStateDeleting ListJobDefinitionsLifecycleStateEnum = "DELETING"
ListJobDefinitionsLifecycleStateDeleted ListJobDefinitionsLifecycleStateEnum = "DELETED"
ListJobDefinitionsLifecycleStateFailed ListJobDefinitionsLifecycleStateEnum = "FAILED"
ListJobDefinitionsLifecycleStateMoving ListJobDefinitionsLifecycleStateEnum = "MOVING"
)
func GetListJobDefinitionsLifecycleStateEnumValues() []ListJobDefinitionsLifecycleStateEnum
GetListJobDefinitionsLifecycleStateEnumValues Enumerates the set of values for ListJobDefinitionsLifecycleStateEnum
func GetMappingListJobDefinitionsLifecycleStateEnum(val string) (ListJobDefinitionsLifecycleStateEnum, bool)
GetMappingListJobDefinitionsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobDefinitionsRequest wrapper for the ListJobDefinitions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobDefinitions.go.html to see an example of how to use ListJobDefinitionsRequest.
type ListJobDefinitionsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// Job execution state.
JobExecutionState ListJobDefinitionsJobExecutionStateEnum `mandatory:"false" contributesTo:"query" name:"jobExecutionState" omitEmpty:"true"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListJobDefinitionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Job type.
JobType ListJobDefinitionsJobTypeEnum `mandatory:"false" contributesTo:"query" name:"jobType" omitEmpty:"true"`
// Whether job definition is an incremental harvest (true) or a full harvest (false).
IsIncremental *bool `mandatory:"false" contributesTo:"query" name:"isIncremental"`
// Unique data asset key.
DataAssetKey *string `mandatory:"false" contributesTo:"query" name:"dataAssetKey"`
// Unique glossary key.
GlossaryKey *string `mandatory:"false" contributesTo:"query" name:"glossaryKey"`
// Unique connection key.
ConnectionKey *string `mandatory:"false" contributesTo:"query" name:"connectionKey"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// The sample data size in MB, specified as number of rows, for a metadata harvest.
SampleDataSizeInMBs *string `mandatory:"false" contributesTo:"query" name:"sampleDataSizeInMBs"`
// Specifies the fields to return in a job definition summary response.
Fields []ListJobDefinitionsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. Default order for TIMELATESTEXECUTIONSTARTED is descending. If no value is specified TIMECREATED is default.
SortBy ListJobDefinitionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListJobDefinitionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListJobDefinitionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListJobDefinitionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListJobDefinitionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListJobDefinitionsRequest) String() string
func (request ListJobDefinitionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListJobDefinitionsResponse wrapper for the ListJobDefinitions operation
type ListJobDefinitionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of JobDefinitionCollection instances
JobDefinitionCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListJobDefinitionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListJobDefinitionsResponse) String() string
ListJobDefinitionsSortByEnum Enum with underlying type: string
type ListJobDefinitionsSortByEnum string
Set of constants representing the allowable values for ListJobDefinitionsSortByEnum
const (
ListJobDefinitionsSortByTimecreated ListJobDefinitionsSortByEnum = "TIMECREATED"
ListJobDefinitionsSortByDisplayname ListJobDefinitionsSortByEnum = "DISPLAYNAME"
ListJobDefinitionsSortByTimelatestexecutionstarted ListJobDefinitionsSortByEnum = "TIMELATESTEXECUTIONSTARTED"
)
func GetListJobDefinitionsSortByEnumValues() []ListJobDefinitionsSortByEnum
GetListJobDefinitionsSortByEnumValues Enumerates the set of values for ListJobDefinitionsSortByEnum
func GetMappingListJobDefinitionsSortByEnum(val string) (ListJobDefinitionsSortByEnum, bool)
GetMappingListJobDefinitionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobDefinitionsSortOrderEnum Enum with underlying type: string
type ListJobDefinitionsSortOrderEnum string
Set of constants representing the allowable values for ListJobDefinitionsSortOrderEnum
const (
ListJobDefinitionsSortOrderAsc ListJobDefinitionsSortOrderEnum = "ASC"
ListJobDefinitionsSortOrderDesc ListJobDefinitionsSortOrderEnum = "DESC"
)
func GetListJobDefinitionsSortOrderEnumValues() []ListJobDefinitionsSortOrderEnum
GetListJobDefinitionsSortOrderEnumValues Enumerates the set of values for ListJobDefinitionsSortOrderEnum
func GetMappingListJobDefinitionsSortOrderEnum(val string) (ListJobDefinitionsSortOrderEnum, bool)
GetMappingListJobDefinitionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobExecutionsFieldsEnum Enum with underlying type: string
type ListJobExecutionsFieldsEnum string
Set of constants representing the allowable values for ListJobExecutionsFieldsEnum
const (
ListJobExecutionsFieldsKey ListJobExecutionsFieldsEnum = "key"
ListJobExecutionsFieldsJobkey ListJobExecutionsFieldsEnum = "jobKey"
ListJobExecutionsFieldsJobtype ListJobExecutionsFieldsEnum = "jobType"
ListJobExecutionsFieldsParentkey ListJobExecutionsFieldsEnum = "parentKey"
ListJobExecutionsFieldsScheduleinstancekey ListJobExecutionsFieldsEnum = "scheduleInstanceKey"
ListJobExecutionsFieldsLifecyclestate ListJobExecutionsFieldsEnum = "lifecycleState"
ListJobExecutionsFieldsTimecreated ListJobExecutionsFieldsEnum = "timeCreated"
ListJobExecutionsFieldsTimestarted ListJobExecutionsFieldsEnum = "timeStarted"
ListJobExecutionsFieldsTimeended ListJobExecutionsFieldsEnum = "timeEnded"
ListJobExecutionsFieldsUri ListJobExecutionsFieldsEnum = "uri"
)
func GetListJobExecutionsFieldsEnumValues() []ListJobExecutionsFieldsEnum
GetListJobExecutionsFieldsEnumValues Enumerates the set of values for ListJobExecutionsFieldsEnum
func GetMappingListJobExecutionsFieldsEnum(val string) (ListJobExecutionsFieldsEnum, bool)
GetMappingListJobExecutionsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobExecutionsJobTypeEnum Enum with underlying type: string
type ListJobExecutionsJobTypeEnum string
Set of constants representing the allowable values for ListJobExecutionsJobTypeEnum
const (
ListJobExecutionsJobTypeHarvest ListJobExecutionsJobTypeEnum = "HARVEST"
ListJobExecutionsJobTypeProfiling ListJobExecutionsJobTypeEnum = "PROFILING"
ListJobExecutionsJobTypeSampling ListJobExecutionsJobTypeEnum = "SAMPLING"
ListJobExecutionsJobTypePreview ListJobExecutionsJobTypeEnum = "PREVIEW"
ListJobExecutionsJobTypeImport ListJobExecutionsJobTypeEnum = "IMPORT"
ListJobExecutionsJobTypeExport ListJobExecutionsJobTypeEnum = "EXPORT"
ListJobExecutionsJobTypeImportGlossary ListJobExecutionsJobTypeEnum = "IMPORT_GLOSSARY"
ListJobExecutionsJobTypeExportGlossary ListJobExecutionsJobTypeEnum = "EXPORT_GLOSSARY"
ListJobExecutionsJobTypeInternal ListJobExecutionsJobTypeEnum = "INTERNAL"
ListJobExecutionsJobTypePurge ListJobExecutionsJobTypeEnum = "PURGE"
ListJobExecutionsJobTypeImmediate ListJobExecutionsJobTypeEnum = "IMMEDIATE"
ListJobExecutionsJobTypeScheduled ListJobExecutionsJobTypeEnum = "SCHEDULED"
ListJobExecutionsJobTypeImmediateExecution ListJobExecutionsJobTypeEnum = "IMMEDIATE_EXECUTION"
ListJobExecutionsJobTypeScheduledExecution ListJobExecutionsJobTypeEnum = "SCHEDULED_EXECUTION"
ListJobExecutionsJobTypeScheduledExecutionInstance ListJobExecutionsJobTypeEnum = "SCHEDULED_EXECUTION_INSTANCE"
ListJobExecutionsJobTypeAsyncDelete ListJobExecutionsJobTypeEnum = "ASYNC_DELETE"
ListJobExecutionsJobTypeImportDataAsset ListJobExecutionsJobTypeEnum = "IMPORT_DATA_ASSET"
ListJobExecutionsJobTypeCreateScanProxy ListJobExecutionsJobTypeEnum = "CREATE_SCAN_PROXY"
ListJobExecutionsJobTypeAsyncExportGlossary ListJobExecutionsJobTypeEnum = "ASYNC_EXPORT_GLOSSARY"
ListJobExecutionsJobTypeAsyncExportDataAsset ListJobExecutionsJobTypeEnum = "ASYNC_EXPORT_DATA_ASSET"
)
func GetListJobExecutionsJobTypeEnumValues() []ListJobExecutionsJobTypeEnum
GetListJobExecutionsJobTypeEnumValues Enumerates the set of values for ListJobExecutionsJobTypeEnum
func GetMappingListJobExecutionsJobTypeEnum(val string) (ListJobExecutionsJobTypeEnum, bool)
GetMappingListJobExecutionsJobTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobExecutionsLifecycleStateEnum Enum with underlying type: string
type ListJobExecutionsLifecycleStateEnum string
Set of constants representing the allowable values for ListJobExecutionsLifecycleStateEnum
const (
ListJobExecutionsLifecycleStateCreated ListJobExecutionsLifecycleStateEnum = "CREATED"
ListJobExecutionsLifecycleStateInProgress ListJobExecutionsLifecycleStateEnum = "IN_PROGRESS"
ListJobExecutionsLifecycleStateInactive ListJobExecutionsLifecycleStateEnum = "INACTIVE"
ListJobExecutionsLifecycleStateFailed ListJobExecutionsLifecycleStateEnum = "FAILED"
ListJobExecutionsLifecycleStateSucceeded ListJobExecutionsLifecycleStateEnum = "SUCCEEDED"
ListJobExecutionsLifecycleStateCanceled ListJobExecutionsLifecycleStateEnum = "CANCELED"
ListJobExecutionsLifecycleStateSucceededWithWarnings ListJobExecutionsLifecycleStateEnum = "SUCCEEDED_WITH_WARNINGS"
)
func GetListJobExecutionsLifecycleStateEnumValues() []ListJobExecutionsLifecycleStateEnum
GetListJobExecutionsLifecycleStateEnumValues Enumerates the set of values for ListJobExecutionsLifecycleStateEnum
func GetMappingListJobExecutionsLifecycleStateEnum(val string) (ListJobExecutionsLifecycleStateEnum, bool)
GetMappingListJobExecutionsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobExecutionsRequest wrapper for the ListJobExecutions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobExecutions.go.html to see an example of how to use ListJobExecutionsRequest.
type ListJobExecutionsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// Job execution lifecycle state.
LifecycleState ListJobExecutionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Job type.
JobType ListJobExecutionsJobTypeEnum `mandatory:"false" contributesTo:"query" name:"jobType" omitEmpty:"true"`
// Sub-type of this job execution.
SubType *string `mandatory:"false" contributesTo:"query" name:"subType"`
// The unique key of the parent execution or null if this job execution has no parent.
ParentKey *string `mandatory:"false" contributesTo:"query" name:"parentKey"`
// Time that the job execution was started or in the case of a future time, the time when the job will start.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeStart *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeStart"`
// Time that the job execution ended or null if the job is still running or hasn't run yet.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeEnd"`
// Error code returned from the job execution or null if job is still running or didn't return an error.
ErrorCode *string `mandatory:"false" contributesTo:"query" name:"errorCode"`
// Error message returned from the job execution or null if job is still running or didn't return an error.
ErrorMessage *string `mandatory:"false" contributesTo:"query" name:"errorMessage"`
// Process identifier related to the job execution.
ProcessKey *string `mandatory:"false" contributesTo:"query" name:"processKey"`
// The a URL of the job for accessing this resource and its status.
ExternalUrl *string `mandatory:"false" contributesTo:"query" name:"externalUrl"`
// Event that triggered the execution of this job or null.
EventKey *string `mandatory:"false" contributesTo:"query" name:"eventKey"`
// Unique entity key.
DataEntityKey *string `mandatory:"false" contributesTo:"query" name:"dataEntityKey"`
// Specifies the fields to return in a job execution summary response.
Fields []ListJobExecutionsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order.
SortBy ListJobExecutionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListJobExecutionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListJobExecutionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListJobExecutionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListJobExecutionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListJobExecutionsRequest) String() string
func (request ListJobExecutionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListJobExecutionsResponse wrapper for the ListJobExecutions operation
type ListJobExecutionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of JobExecutionCollection instances
JobExecutionCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListJobExecutionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListJobExecutionsResponse) String() string
ListJobExecutionsSortByEnum Enum with underlying type: string
type ListJobExecutionsSortByEnum string
Set of constants representing the allowable values for ListJobExecutionsSortByEnum
const (
ListJobExecutionsSortByTimecreated ListJobExecutionsSortByEnum = "TIMECREATED"
)
func GetListJobExecutionsSortByEnumValues() []ListJobExecutionsSortByEnum
GetListJobExecutionsSortByEnumValues Enumerates the set of values for ListJobExecutionsSortByEnum
func GetMappingListJobExecutionsSortByEnum(val string) (ListJobExecutionsSortByEnum, bool)
GetMappingListJobExecutionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobExecutionsSortOrderEnum Enum with underlying type: string
type ListJobExecutionsSortOrderEnum string
Set of constants representing the allowable values for ListJobExecutionsSortOrderEnum
const (
ListJobExecutionsSortOrderAsc ListJobExecutionsSortOrderEnum = "ASC"
ListJobExecutionsSortOrderDesc ListJobExecutionsSortOrderEnum = "DESC"
)
func GetListJobExecutionsSortOrderEnumValues() []ListJobExecutionsSortOrderEnum
GetListJobExecutionsSortOrderEnumValues Enumerates the set of values for ListJobExecutionsSortOrderEnum
func GetMappingListJobExecutionsSortOrderEnum(val string) (ListJobExecutionsSortOrderEnum, bool)
GetMappingListJobExecutionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobLogsFieldsEnum Enum with underlying type: string
type ListJobLogsFieldsEnum string
Set of constants representing the allowable values for ListJobLogsFieldsEnum
const (
ListJobLogsFieldsKey ListJobLogsFieldsEnum = "key"
ListJobLogsFieldsJobexecutionkey ListJobLogsFieldsEnum = "jobExecutionKey"
ListJobLogsFieldsSeverity ListJobLogsFieldsEnum = "severity"
ListJobLogsFieldsTimecreated ListJobLogsFieldsEnum = "timeCreated"
ListJobLogsFieldsLogmessage ListJobLogsFieldsEnum = "logMessage"
ListJobLogsFieldsUri ListJobLogsFieldsEnum = "uri"
)
func GetListJobLogsFieldsEnumValues() []ListJobLogsFieldsEnum
GetListJobLogsFieldsEnumValues Enumerates the set of values for ListJobLogsFieldsEnum
func GetMappingListJobLogsFieldsEnum(val string) (ListJobLogsFieldsEnum, bool)
GetMappingListJobLogsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobLogsLifecycleStateEnum Enum with underlying type: string
type ListJobLogsLifecycleStateEnum string
Set of constants representing the allowable values for ListJobLogsLifecycleStateEnum
const (
ListJobLogsLifecycleStateCreating ListJobLogsLifecycleStateEnum = "CREATING"
ListJobLogsLifecycleStateActive ListJobLogsLifecycleStateEnum = "ACTIVE"
ListJobLogsLifecycleStateInactive ListJobLogsLifecycleStateEnum = "INACTIVE"
ListJobLogsLifecycleStateUpdating ListJobLogsLifecycleStateEnum = "UPDATING"
ListJobLogsLifecycleStateDeleting ListJobLogsLifecycleStateEnum = "DELETING"
ListJobLogsLifecycleStateDeleted ListJobLogsLifecycleStateEnum = "DELETED"
ListJobLogsLifecycleStateFailed ListJobLogsLifecycleStateEnum = "FAILED"
ListJobLogsLifecycleStateMoving ListJobLogsLifecycleStateEnum = "MOVING"
)
func GetListJobLogsLifecycleStateEnumValues() []ListJobLogsLifecycleStateEnum
GetListJobLogsLifecycleStateEnumValues Enumerates the set of values for ListJobLogsLifecycleStateEnum
func GetMappingListJobLogsLifecycleStateEnum(val string) (ListJobLogsLifecycleStateEnum, bool)
GetMappingListJobLogsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobLogsRequest wrapper for the ListJobLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobLogs.go.html to see an example of how to use ListJobLogsRequest.
type ListJobLogsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// The key of the job execution.
JobExecutionKey *string `mandatory:"true" contributesTo:"path" name:"jobExecutionKey"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListJobLogsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Severity level for this Log.
Severity *string `mandatory:"false" contributesTo:"query" name:"severity"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Specifies the fields to return in a job log summary response.
Fields []ListJobLogsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListJobLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListJobLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListJobLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListJobLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListJobLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListJobLogsRequest) String() string
func (request ListJobLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListJobLogsResponse wrapper for the ListJobLogs operation
type ListJobLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of JobLogCollection instances
JobLogCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListJobLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListJobLogsResponse) String() string
ListJobLogsSortByEnum Enum with underlying type: string
type ListJobLogsSortByEnum string
Set of constants representing the allowable values for ListJobLogsSortByEnum
const (
ListJobLogsSortByTimecreated ListJobLogsSortByEnum = "TIMECREATED"
ListJobLogsSortByDisplayname ListJobLogsSortByEnum = "DISPLAYNAME"
)
func GetListJobLogsSortByEnumValues() []ListJobLogsSortByEnum
GetListJobLogsSortByEnumValues Enumerates the set of values for ListJobLogsSortByEnum
func GetMappingListJobLogsSortByEnum(val string) (ListJobLogsSortByEnum, bool)
GetMappingListJobLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobLogsSortOrderEnum Enum with underlying type: string
type ListJobLogsSortOrderEnum string
Set of constants representing the allowable values for ListJobLogsSortOrderEnum
const (
ListJobLogsSortOrderAsc ListJobLogsSortOrderEnum = "ASC"
ListJobLogsSortOrderDesc ListJobLogsSortOrderEnum = "DESC"
)
func GetListJobLogsSortOrderEnumValues() []ListJobLogsSortOrderEnum
GetListJobLogsSortOrderEnumValues Enumerates the set of values for ListJobLogsSortOrderEnum
func GetMappingListJobLogsSortOrderEnum(val string) (ListJobLogsSortOrderEnum, bool)
GetMappingListJobLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobMetricsFieldsEnum Enum with underlying type: string
type ListJobMetricsFieldsEnum string
Set of constants representing the allowable values for ListJobMetricsFieldsEnum
const (
ListJobMetricsFieldsKey ListJobMetricsFieldsEnum = "key"
ListJobMetricsFieldsDescription ListJobMetricsFieldsEnum = "description"
ListJobMetricsFieldsDisplayname ListJobMetricsFieldsEnum = "displayName"
ListJobMetricsFieldsTimeinserted ListJobMetricsFieldsEnum = "timeInserted"
ListJobMetricsFieldsCategory ListJobMetricsFieldsEnum = "category"
ListJobMetricsFieldsSubcategory ListJobMetricsFieldsEnum = "subCategory"
ListJobMetricsFieldsUnit ListJobMetricsFieldsEnum = "unit"
ListJobMetricsFieldsValue ListJobMetricsFieldsEnum = "value"
ListJobMetricsFieldsBatchkey ListJobMetricsFieldsEnum = "batchKey"
ListJobMetricsFieldsJobexecutionkey ListJobMetricsFieldsEnum = "jobExecutionKey"
ListJobMetricsFieldsTimecreated ListJobMetricsFieldsEnum = "timeCreated"
ListJobMetricsFieldsUri ListJobMetricsFieldsEnum = "uri"
)
func GetListJobMetricsFieldsEnumValues() []ListJobMetricsFieldsEnum
GetListJobMetricsFieldsEnumValues Enumerates the set of values for ListJobMetricsFieldsEnum
func GetMappingListJobMetricsFieldsEnum(val string) (ListJobMetricsFieldsEnum, bool)
GetMappingListJobMetricsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobMetricsRequest wrapper for the ListJobMetrics operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobMetrics.go.html to see an example of how to use ListJobMetricsRequest.
type ListJobMetricsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// The key of the job execution.
JobExecutionKey *string `mandatory:"true" contributesTo:"path" name:"jobExecutionKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// Category of this metric.
Category *string `mandatory:"false" contributesTo:"query" name:"category"`
// Sub category of this metric under the category. Used for aggregating values. May be null.
SubCategory *string `mandatory:"false" contributesTo:"query" name:"subCategory"`
// Unit of this metric.
Unit *string `mandatory:"false" contributesTo:"query" name:"unit"`
// Value of this metric.
Value *string `mandatory:"false" contributesTo:"query" name:"value"`
// Batch key for grouping, may be null.
BatchKey *string `mandatory:"false" contributesTo:"query" name:"batchKey"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// The time the metric was logged or captured in the system where the job executed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeInserted *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeInserted"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Specifies the fields to return in a job metric summary response.
Fields []ListJobMetricsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListJobMetricsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListJobMetricsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListJobMetricsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListJobMetricsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListJobMetricsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListJobMetricsRequest) String() string
func (request ListJobMetricsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListJobMetricsResponse wrapper for the ListJobMetrics operation
type ListJobMetricsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of JobMetricCollection instances
JobMetricCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListJobMetricsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListJobMetricsResponse) String() string
ListJobMetricsSortByEnum Enum with underlying type: string
type ListJobMetricsSortByEnum string
Set of constants representing the allowable values for ListJobMetricsSortByEnum
const (
ListJobMetricsSortByTimecreated ListJobMetricsSortByEnum = "TIMECREATED"
ListJobMetricsSortByDisplayname ListJobMetricsSortByEnum = "DISPLAYNAME"
)
func GetListJobMetricsSortByEnumValues() []ListJobMetricsSortByEnum
GetListJobMetricsSortByEnumValues Enumerates the set of values for ListJobMetricsSortByEnum
func GetMappingListJobMetricsSortByEnum(val string) (ListJobMetricsSortByEnum, bool)
GetMappingListJobMetricsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobMetricsSortOrderEnum Enum with underlying type: string
type ListJobMetricsSortOrderEnum string
Set of constants representing the allowable values for ListJobMetricsSortOrderEnum
const (
ListJobMetricsSortOrderAsc ListJobMetricsSortOrderEnum = "ASC"
ListJobMetricsSortOrderDesc ListJobMetricsSortOrderEnum = "DESC"
)
func GetListJobMetricsSortOrderEnumValues() []ListJobMetricsSortOrderEnum
GetListJobMetricsSortOrderEnumValues Enumerates the set of values for ListJobMetricsSortOrderEnum
func GetMappingListJobMetricsSortOrderEnum(val string) (ListJobMetricsSortOrderEnum, bool)
GetMappingListJobMetricsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobsFieldsEnum Enum with underlying type: string
type ListJobsFieldsEnum string
Set of constants representing the allowable values for ListJobsFieldsEnum
const (
ListJobsFieldsKey ListJobsFieldsEnum = "key"
ListJobsFieldsDisplayname ListJobsFieldsEnum = "displayName"
ListJobsFieldsDescription ListJobsFieldsEnum = "description"
ListJobsFieldsCatalogid ListJobsFieldsEnum = "catalogId"
ListJobsFieldsJobdefinitionkey ListJobsFieldsEnum = "jobDefinitionKey"
ListJobsFieldsLifecyclestate ListJobsFieldsEnum = "lifecycleState"
ListJobsFieldsTimecreated ListJobsFieldsEnum = "timeCreated"
ListJobsFieldsTimeupdated ListJobsFieldsEnum = "timeUpdated"
ListJobsFieldsCreatedbyid ListJobsFieldsEnum = "createdById"
ListJobsFieldsUpdatedbyid ListJobsFieldsEnum = "updatedById"
ListJobsFieldsJobtype ListJobsFieldsEnum = "jobType"
ListJobsFieldsSchedulecronexpression ListJobsFieldsEnum = "scheduleCronExpression"
ListJobsFieldsTimeschedulebegin ListJobsFieldsEnum = "timeScheduleBegin"
ListJobsFieldsScheduletype ListJobsFieldsEnum = "scheduleType"
ListJobsFieldsExecutioncount ListJobsFieldsEnum = "executionCount"
ListJobsFieldsTimeoflatestexecution ListJobsFieldsEnum = "timeOfLatestExecution"
ListJobsFieldsExecutions ListJobsFieldsEnum = "executions"
ListJobsFieldsUri ListJobsFieldsEnum = "uri"
ListJobsFieldsJobdefinitionname ListJobsFieldsEnum = "jobDefinitionName"
ListJobsFieldsErrorcode ListJobsFieldsEnum = "errorCode"
ListJobsFieldsErrormessage ListJobsFieldsEnum = "errorMessage"
)
func GetListJobsFieldsEnumValues() []ListJobsFieldsEnum
GetListJobsFieldsEnumValues Enumerates the set of values for ListJobsFieldsEnum
func GetMappingListJobsFieldsEnum(val string) (ListJobsFieldsEnum, bool)
GetMappingListJobsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobsJobTypeEnum Enum with underlying type: string
type ListJobsJobTypeEnum string
Set of constants representing the allowable values for ListJobsJobTypeEnum
const (
ListJobsJobTypeHarvest ListJobsJobTypeEnum = "HARVEST"
ListJobsJobTypeProfiling ListJobsJobTypeEnum = "PROFILING"
ListJobsJobTypeSampling ListJobsJobTypeEnum = "SAMPLING"
ListJobsJobTypePreview ListJobsJobTypeEnum = "PREVIEW"
ListJobsJobTypeImport ListJobsJobTypeEnum = "IMPORT"
ListJobsJobTypeExport ListJobsJobTypeEnum = "EXPORT"
ListJobsJobTypeImportGlossary ListJobsJobTypeEnum = "IMPORT_GLOSSARY"
ListJobsJobTypeExportGlossary ListJobsJobTypeEnum = "EXPORT_GLOSSARY"
ListJobsJobTypeInternal ListJobsJobTypeEnum = "INTERNAL"
ListJobsJobTypePurge ListJobsJobTypeEnum = "PURGE"
ListJobsJobTypeImmediate ListJobsJobTypeEnum = "IMMEDIATE"
ListJobsJobTypeScheduled ListJobsJobTypeEnum = "SCHEDULED"
ListJobsJobTypeImmediateExecution ListJobsJobTypeEnum = "IMMEDIATE_EXECUTION"
ListJobsJobTypeScheduledExecution ListJobsJobTypeEnum = "SCHEDULED_EXECUTION"
ListJobsJobTypeScheduledExecutionInstance ListJobsJobTypeEnum = "SCHEDULED_EXECUTION_INSTANCE"
ListJobsJobTypeAsyncDelete ListJobsJobTypeEnum = "ASYNC_DELETE"
ListJobsJobTypeImportDataAsset ListJobsJobTypeEnum = "IMPORT_DATA_ASSET"
ListJobsJobTypeCreateScanProxy ListJobsJobTypeEnum = "CREATE_SCAN_PROXY"
ListJobsJobTypeAsyncExportGlossary ListJobsJobTypeEnum = "ASYNC_EXPORT_GLOSSARY"
ListJobsJobTypeAsyncExportDataAsset ListJobsJobTypeEnum = "ASYNC_EXPORT_DATA_ASSET"
)
func GetListJobsJobTypeEnumValues() []ListJobsJobTypeEnum
GetListJobsJobTypeEnumValues Enumerates the set of values for ListJobsJobTypeEnum
func GetMappingListJobsJobTypeEnum(val string) (ListJobsJobTypeEnum, bool)
GetMappingListJobsJobTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobsLifecycleStateEnum Enum with underlying type: string
type ListJobsLifecycleStateEnum string
Set of constants representing the allowable values for ListJobsLifecycleStateEnum
const (
ListJobsLifecycleStateActive ListJobsLifecycleStateEnum = "ACTIVE"
ListJobsLifecycleStateInactive ListJobsLifecycleStateEnum = "INACTIVE"
ListJobsLifecycleStateExpired ListJobsLifecycleStateEnum = "EXPIRED"
)
func GetListJobsLifecycleStateEnumValues() []ListJobsLifecycleStateEnum
GetListJobsLifecycleStateEnumValues Enumerates the set of values for ListJobsLifecycleStateEnum
func GetMappingListJobsLifecycleStateEnum(val string) (ListJobsLifecycleStateEnum, bool)
GetMappingListJobsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobsRequest wrapper for the ListJobs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListJobs.go.html to see an example of how to use ListJobsRequest.
type ListJobsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// Job lifecycle state.
LifecycleState ListJobsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Job type.
JobType ListJobsJobTypeEnum `mandatory:"false" contributesTo:"query" name:"jobType" omitEmpty:"true"`
// Unique job definition key.
JobDefinitionKey *string `mandatory:"false" contributesTo:"query" name:"jobDefinitionKey"`
// Unique data asset key.
DataAssetKey *string `mandatory:"false" contributesTo:"query" name:"dataAssetKey"`
// Unique glossary key.
GlossaryKey *string `mandatory:"false" contributesTo:"query" name:"glossaryKey"`
// Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".
// The following subset of those is supported: @monthly, @weekly, @daily, @hourly.
// For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.
ScheduleCronExpression *string `mandatory:"false" contributesTo:"query" name:"scheduleCronExpression"`
// Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleBegin *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeScheduleBegin"`
// Date that the schedule should end from being operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeScheduleEnd"`
// Type of the job schedule.
ScheduleType ListJobsScheduleTypeEnum `mandatory:"false" contributesTo:"query" name:"scheduleType" omitEmpty:"true"`
// Unique connection key.
ConnectionKey *string `mandatory:"false" contributesTo:"query" name:"connectionKey"`
// Specifies the fields to return in a job summary response.
Fields []ListJobsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The total number of executions for this job schedule.
ExecutionCount *int `mandatory:"false" contributesTo:"query" name:"executionCount"`
// The date and time the most recent execution for this job ,in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeOfLatestExecution *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeOfLatestExecution"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListJobsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListJobsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListJobsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListJobsRequest) String() string
func (request ListJobsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListJobsResponse wrapper for the ListJobs operation
type ListJobsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of JobCollection instances
JobCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListJobsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListJobsResponse) String() string
ListJobsScheduleTypeEnum Enum with underlying type: string
type ListJobsScheduleTypeEnum string
Set of constants representing the allowable values for ListJobsScheduleTypeEnum
const (
ListJobsScheduleTypeScheduled ListJobsScheduleTypeEnum = "SCHEDULED"
ListJobsScheduleTypeImmediate ListJobsScheduleTypeEnum = "IMMEDIATE"
)
func GetListJobsScheduleTypeEnumValues() []ListJobsScheduleTypeEnum
GetListJobsScheduleTypeEnumValues Enumerates the set of values for ListJobsScheduleTypeEnum
func GetMappingListJobsScheduleTypeEnum(val string) (ListJobsScheduleTypeEnum, bool)
GetMappingListJobsScheduleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobsSortByEnum Enum with underlying type: string
type ListJobsSortByEnum string
Set of constants representing the allowable values for ListJobsSortByEnum
const (
ListJobsSortByTimecreated ListJobsSortByEnum = "TIMECREATED"
ListJobsSortByDisplayname ListJobsSortByEnum = "DISPLAYNAME"
)
func GetListJobsSortByEnumValues() []ListJobsSortByEnum
GetListJobsSortByEnumValues Enumerates the set of values for ListJobsSortByEnum
func GetMappingListJobsSortByEnum(val string) (ListJobsSortByEnum, bool)
GetMappingListJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobsSortOrderEnum Enum with underlying type: string
type ListJobsSortOrderEnum string
Set of constants representing the allowable values for ListJobsSortOrderEnum
const (
ListJobsSortOrderAsc ListJobsSortOrderEnum = "ASC"
ListJobsSortOrderDesc ListJobsSortOrderEnum = "DESC"
)
func GetListJobsSortOrderEnumValues() []ListJobsSortOrderEnum
GetListJobsSortOrderEnumValues Enumerates the set of values for ListJobsSortOrderEnum
func GetMappingListJobsSortOrderEnum(val string) (ListJobsSortOrderEnum, bool)
GetMappingListJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListMetastoresLifecycleStateEnum Enum with underlying type: string
type ListMetastoresLifecycleStateEnum string
Set of constants representing the allowable values for ListMetastoresLifecycleStateEnum
const (
ListMetastoresLifecycleStateCreating ListMetastoresLifecycleStateEnum = "CREATING"
ListMetastoresLifecycleStateActive ListMetastoresLifecycleStateEnum = "ACTIVE"
ListMetastoresLifecycleStateInactive ListMetastoresLifecycleStateEnum = "INACTIVE"
ListMetastoresLifecycleStateUpdating ListMetastoresLifecycleStateEnum = "UPDATING"
ListMetastoresLifecycleStateDeleting ListMetastoresLifecycleStateEnum = "DELETING"
ListMetastoresLifecycleStateDeleted ListMetastoresLifecycleStateEnum = "DELETED"
ListMetastoresLifecycleStateFailed ListMetastoresLifecycleStateEnum = "FAILED"
ListMetastoresLifecycleStateMoving ListMetastoresLifecycleStateEnum = "MOVING"
)
func GetListMetastoresLifecycleStateEnumValues() []ListMetastoresLifecycleStateEnum
GetListMetastoresLifecycleStateEnumValues Enumerates the set of values for ListMetastoresLifecycleStateEnum
func GetMappingListMetastoresLifecycleStateEnum(val string) (ListMetastoresLifecycleStateEnum, bool)
GetMappingListMetastoresLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListMetastoresRequest wrapper for the ListMetastores operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListMetastores.go.html to see an example of how to use ListMetastoresRequest.
type ListMetastoresRequest struct {
// The OCID of the compartment where you want to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
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"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListMetastoresLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListMetastoresSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListMetastoresSortByEnum `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 ListMetastoresRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMetastoresRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMetastoresRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMetastoresRequest) String() string
func (request ListMetastoresRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListMetastoresResponse wrapper for the ListMetastores operation
type ListMetastoresResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []MetastoreSummary instances
Items []MetastoreSummary `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListMetastoresResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMetastoresResponse) String() string
ListMetastoresSortByEnum Enum with underlying type: string
type ListMetastoresSortByEnum string
Set of constants representing the allowable values for ListMetastoresSortByEnum
const (
ListMetastoresSortByTimecreated ListMetastoresSortByEnum = "TIMECREATED"
ListMetastoresSortByDisplayname ListMetastoresSortByEnum = "DISPLAYNAME"
)
func GetListMetastoresSortByEnumValues() []ListMetastoresSortByEnum
GetListMetastoresSortByEnumValues Enumerates the set of values for ListMetastoresSortByEnum
func GetMappingListMetastoresSortByEnum(val string) (ListMetastoresSortByEnum, bool)
GetMappingListMetastoresSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListMetastoresSortOrderEnum Enum with underlying type: string
type ListMetastoresSortOrderEnum string
Set of constants representing the allowable values for ListMetastoresSortOrderEnum
const (
ListMetastoresSortOrderAsc ListMetastoresSortOrderEnum = "ASC"
ListMetastoresSortOrderDesc ListMetastoresSortOrderEnum = "DESC"
)
func GetListMetastoresSortOrderEnumValues() []ListMetastoresSortOrderEnum
GetListMetastoresSortOrderEnumValues Enumerates the set of values for ListMetastoresSortOrderEnum
func GetMappingListMetastoresSortOrderEnum(val string) (ListMetastoresSortOrderEnum, bool)
GetMappingListMetastoresSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNamespacesFieldsEnum Enum with underlying type: string
type ListNamespacesFieldsEnum string
Set of constants representing the allowable values for ListNamespacesFieldsEnum
const (
ListNamespacesFieldsKey ListNamespacesFieldsEnum = "key"
ListNamespacesFieldsDisplayname ListNamespacesFieldsEnum = "displayName"
ListNamespacesFieldsDescription ListNamespacesFieldsEnum = "description"
ListNamespacesFieldsLifecyclestate ListNamespacesFieldsEnum = "lifecycleState"
ListNamespacesFieldsTimecreated ListNamespacesFieldsEnum = "timeCreated"
)
func GetListNamespacesFieldsEnumValues() []ListNamespacesFieldsEnum
GetListNamespacesFieldsEnumValues Enumerates the set of values for ListNamespacesFieldsEnum
func GetMappingListNamespacesFieldsEnum(val string) (ListNamespacesFieldsEnum, bool)
GetMappingListNamespacesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListNamespacesLifecycleStateEnum Enum with underlying type: string
type ListNamespacesLifecycleStateEnum string
Set of constants representing the allowable values for ListNamespacesLifecycleStateEnum
const (
ListNamespacesLifecycleStateCreating ListNamespacesLifecycleStateEnum = "CREATING"
ListNamespacesLifecycleStateActive ListNamespacesLifecycleStateEnum = "ACTIVE"
ListNamespacesLifecycleStateInactive ListNamespacesLifecycleStateEnum = "INACTIVE"
ListNamespacesLifecycleStateUpdating ListNamespacesLifecycleStateEnum = "UPDATING"
ListNamespacesLifecycleStateDeleting ListNamespacesLifecycleStateEnum = "DELETING"
ListNamespacesLifecycleStateDeleted ListNamespacesLifecycleStateEnum = "DELETED"
ListNamespacesLifecycleStateFailed ListNamespacesLifecycleStateEnum = "FAILED"
ListNamespacesLifecycleStateMoving ListNamespacesLifecycleStateEnum = "MOVING"
)
func GetListNamespacesLifecycleStateEnumValues() []ListNamespacesLifecycleStateEnum
GetListNamespacesLifecycleStateEnumValues Enumerates the set of values for ListNamespacesLifecycleStateEnum
func GetMappingListNamespacesLifecycleStateEnum(val string) (ListNamespacesLifecycleStateEnum, bool)
GetMappingListNamespacesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListNamespacesRequest wrapper for the ListNamespaces operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListNamespaces.go.html to see an example of how to use ListNamespacesRequest.
type ListNamespacesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListNamespacesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListNamespacesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListNamespacesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the fields to return in a namespace summary response.
Fields []ListNamespacesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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 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 ListNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNamespacesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNamespacesRequest) String() string
func (request ListNamespacesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListNamespacesResponse wrapper for the ListNamespaces operation
type ListNamespacesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of NamespaceCollection instances
NamespaceCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListNamespacesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNamespacesResponse) String() string
ListNamespacesSortByEnum Enum with underlying type: string
type ListNamespacesSortByEnum string
Set of constants representing the allowable values for ListNamespacesSortByEnum
const (
ListNamespacesSortByTimecreated ListNamespacesSortByEnum = "TIMECREATED"
ListNamespacesSortByDisplayname ListNamespacesSortByEnum = "DISPLAYNAME"
)
func GetListNamespacesSortByEnumValues() []ListNamespacesSortByEnum
GetListNamespacesSortByEnumValues Enumerates the set of values for ListNamespacesSortByEnum
func GetMappingListNamespacesSortByEnum(val string) (ListNamespacesSortByEnum, bool)
GetMappingListNamespacesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNamespacesSortOrderEnum Enum with underlying type: string
type ListNamespacesSortOrderEnum string
Set of constants representing the allowable values for ListNamespacesSortOrderEnum
const (
ListNamespacesSortOrderAsc ListNamespacesSortOrderEnum = "ASC"
ListNamespacesSortOrderDesc ListNamespacesSortOrderEnum = "DESC"
)
func GetListNamespacesSortOrderEnumValues() []ListNamespacesSortOrderEnum
GetListNamespacesSortOrderEnumValues Enumerates the set of values for ListNamespacesSortOrderEnum
func GetMappingListNamespacesSortOrderEnum(val string) (ListNamespacesSortOrderEnum, bool)
GetMappingListNamespacesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPatternsFieldsEnum Enum with underlying type: string
type ListPatternsFieldsEnum string
Set of constants representing the allowable values for ListPatternsFieldsEnum
const (
ListPatternsFieldsKey ListPatternsFieldsEnum = "key"
ListPatternsFieldsDisplayname ListPatternsFieldsEnum = "displayName"
ListPatternsFieldsDescription ListPatternsFieldsEnum = "description"
ListPatternsFieldsCatalogid ListPatternsFieldsEnum = "catalogId"
ListPatternsFieldsExpression ListPatternsFieldsEnum = "expression"
ListPatternsFieldsLifecyclestate ListPatternsFieldsEnum = "lifecycleState"
ListPatternsFieldsTimecreated ListPatternsFieldsEnum = "timeCreated"
)
func GetListPatternsFieldsEnumValues() []ListPatternsFieldsEnum
GetListPatternsFieldsEnumValues Enumerates the set of values for ListPatternsFieldsEnum
func GetMappingListPatternsFieldsEnum(val string) (ListPatternsFieldsEnum, bool)
GetMappingListPatternsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListPatternsLifecycleStateEnum Enum with underlying type: string
type ListPatternsLifecycleStateEnum string
Set of constants representing the allowable values for ListPatternsLifecycleStateEnum
const (
ListPatternsLifecycleStateCreating ListPatternsLifecycleStateEnum = "CREATING"
ListPatternsLifecycleStateActive ListPatternsLifecycleStateEnum = "ACTIVE"
ListPatternsLifecycleStateInactive ListPatternsLifecycleStateEnum = "INACTIVE"
ListPatternsLifecycleStateUpdating ListPatternsLifecycleStateEnum = "UPDATING"
ListPatternsLifecycleStateDeleting ListPatternsLifecycleStateEnum = "DELETING"
ListPatternsLifecycleStateDeleted ListPatternsLifecycleStateEnum = "DELETED"
ListPatternsLifecycleStateFailed ListPatternsLifecycleStateEnum = "FAILED"
ListPatternsLifecycleStateMoving ListPatternsLifecycleStateEnum = "MOVING"
)
func GetListPatternsLifecycleStateEnumValues() []ListPatternsLifecycleStateEnum
GetListPatternsLifecycleStateEnumValues Enumerates the set of values for ListPatternsLifecycleStateEnum
func GetMappingListPatternsLifecycleStateEnum(val string) (ListPatternsLifecycleStateEnum, bool)
GetMappingListPatternsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListPatternsRequest wrapper for the ListPatterns operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListPatterns.go.html to see an example of how to use ListPatternsRequest.
type ListPatternsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListPatternsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Specifies the fields to return in a pattern summary response.
Fields []ListPatternsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListPatternsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListPatternsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListPatternsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPatternsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPatternsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPatternsRequest) String() string
func (request ListPatternsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPatternsResponse wrapper for the ListPatterns operation
type ListPatternsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PatternCollection instances
PatternCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPatternsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPatternsResponse) String() string
ListPatternsSortByEnum Enum with underlying type: string
type ListPatternsSortByEnum string
Set of constants representing the allowable values for ListPatternsSortByEnum
const (
ListPatternsSortByTimecreated ListPatternsSortByEnum = "TIMECREATED"
ListPatternsSortByDisplayname ListPatternsSortByEnum = "DISPLAYNAME"
)
func GetListPatternsSortByEnumValues() []ListPatternsSortByEnum
GetListPatternsSortByEnumValues Enumerates the set of values for ListPatternsSortByEnum
func GetMappingListPatternsSortByEnum(val string) (ListPatternsSortByEnum, bool)
GetMappingListPatternsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPatternsSortOrderEnum Enum with underlying type: string
type ListPatternsSortOrderEnum string
Set of constants representing the allowable values for ListPatternsSortOrderEnum
const (
ListPatternsSortOrderAsc ListPatternsSortOrderEnum = "ASC"
ListPatternsSortOrderDesc ListPatternsSortOrderEnum = "DESC"
)
func GetListPatternsSortOrderEnumValues() []ListPatternsSortOrderEnum
GetListPatternsSortOrderEnumValues Enumerates the set of values for ListPatternsSortOrderEnum
func GetMappingListPatternsSortOrderEnum(val string) (ListPatternsSortOrderEnum, bool)
GetMappingListPatternsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRulesFieldsEnum Enum with underlying type: string
type ListRulesFieldsEnum string
Set of constants representing the allowable values for ListRulesFieldsEnum
const (
ListRulesFieldsKey ListRulesFieldsEnum = "key"
ListRulesFieldsDisplayname ListRulesFieldsEnum = "displayName"
ListRulesFieldsRuletype ListRulesFieldsEnum = "ruleType"
ListRulesFieldsExternalkey ListRulesFieldsEnum = "externalKey"
ListRulesFieldsReferencedfolderkey ListRulesFieldsEnum = "referencedFolderKey"
ListRulesFieldsReferencedfoldername ListRulesFieldsEnum = "referencedFolderName"
ListRulesFieldsReferencedentitykey ListRulesFieldsEnum = "referencedEntityKey"
ListRulesFieldsReferencedentityname ListRulesFieldsEnum = "referencedEntityName"
ListRulesFieldsReferencedrulekey ListRulesFieldsEnum = "referencedRuleKey"
ListRulesFieldsReferencedrulename ListRulesFieldsEnum = "referencedRuleName"
ListRulesFieldsOrigintype ListRulesFieldsEnum = "originType"
ListRulesFieldsLifecyclestate ListRulesFieldsEnum = "lifecycleState"
ListRulesFieldsTimecreated ListRulesFieldsEnum = "timeCreated"
ListRulesFieldsUri ListRulesFieldsEnum = "uri"
)
func GetListRulesFieldsEnumValues() []ListRulesFieldsEnum
GetListRulesFieldsEnumValues Enumerates the set of values for ListRulesFieldsEnum
func GetMappingListRulesFieldsEnum(val string) (ListRulesFieldsEnum, bool)
GetMappingListRulesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListRulesLifecycleStateEnum Enum with underlying type: string
type ListRulesLifecycleStateEnum string
Set of constants representing the allowable values for ListRulesLifecycleStateEnum
const (
ListRulesLifecycleStateCreating ListRulesLifecycleStateEnum = "CREATING"
ListRulesLifecycleStateActive ListRulesLifecycleStateEnum = "ACTIVE"
ListRulesLifecycleStateInactive ListRulesLifecycleStateEnum = "INACTIVE"
ListRulesLifecycleStateUpdating ListRulesLifecycleStateEnum = "UPDATING"
ListRulesLifecycleStateDeleting ListRulesLifecycleStateEnum = "DELETING"
ListRulesLifecycleStateDeleted ListRulesLifecycleStateEnum = "DELETED"
ListRulesLifecycleStateFailed ListRulesLifecycleStateEnum = "FAILED"
ListRulesLifecycleStateMoving ListRulesLifecycleStateEnum = "MOVING"
)
func GetListRulesLifecycleStateEnumValues() []ListRulesLifecycleStateEnum
GetListRulesLifecycleStateEnumValues Enumerates the set of values for ListRulesLifecycleStateEnum
func GetMappingListRulesLifecycleStateEnum(val string) (ListRulesLifecycleStateEnum, bool)
GetMappingListRulesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRulesOriginTypeEnum Enum with underlying type: string
type ListRulesOriginTypeEnum string
Set of constants representing the allowable values for ListRulesOriginTypeEnum
const (
ListRulesOriginTypeSource ListRulesOriginTypeEnum = "SOURCE"
ListRulesOriginTypeUser ListRulesOriginTypeEnum = "USER"
ListRulesOriginTypeProfiling ListRulesOriginTypeEnum = "PROFILING"
)
func GetListRulesOriginTypeEnumValues() []ListRulesOriginTypeEnum
GetListRulesOriginTypeEnumValues Enumerates the set of values for ListRulesOriginTypeEnum
func GetMappingListRulesOriginTypeEnum(val string) (ListRulesOriginTypeEnum, bool)
GetMappingListRulesOriginTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListRulesRequest wrapper for the ListRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListRules.go.html to see an example of how to use ListRulesRequest.
type ListRulesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// Rule type used to filter the response to a list rules call.
RuleType ListRulesRuleTypeEnum `mandatory:"false" contributesTo:"query" name:"ruleType" omitEmpty:"true"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListRulesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Rule origin type used to filter the response to a list rules call.
OriginType ListRulesOriginTypeEnum `mandatory:"false" contributesTo:"query" name:"originType" omitEmpty:"true"`
// Unique external identifier of this resource in the external source system.
ExternalKey *string `mandatory:"false" contributesTo:"query" name:"externalKey"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Specifies the fields to return in a rule summary response.
Fields []ListRulesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListRulesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListRulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRulesRequest) String() string
func (request ListRulesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListRulesResponse wrapper for the ListRules operation
type ListRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RuleCollection instances
RuleCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRulesResponse) String() string
ListRulesRuleTypeEnum Enum with underlying type: string
type ListRulesRuleTypeEnum string
Set of constants representing the allowable values for ListRulesRuleTypeEnum
const (
ListRulesRuleTypePrimarykey ListRulesRuleTypeEnum = "PRIMARYKEY"
ListRulesRuleTypeForeignkey ListRulesRuleTypeEnum = "FOREIGNKEY"
ListRulesRuleTypeUniquekey ListRulesRuleTypeEnum = "UNIQUEKEY"
)
func GetListRulesRuleTypeEnumValues() []ListRulesRuleTypeEnum
GetListRulesRuleTypeEnumValues Enumerates the set of values for ListRulesRuleTypeEnum
func GetMappingListRulesRuleTypeEnum(val string) (ListRulesRuleTypeEnum, bool)
GetMappingListRulesRuleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListRulesSortByEnum Enum with underlying type: string
type ListRulesSortByEnum string
Set of constants representing the allowable values for ListRulesSortByEnum
const (
ListRulesSortByTimecreated ListRulesSortByEnum = "TIMECREATED"
ListRulesSortByDisplayname ListRulesSortByEnum = "DISPLAYNAME"
)
func GetListRulesSortByEnumValues() []ListRulesSortByEnum
GetListRulesSortByEnumValues Enumerates the set of values for ListRulesSortByEnum
func GetMappingListRulesSortByEnum(val string) (ListRulesSortByEnum, bool)
GetMappingListRulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRulesSortOrderEnum Enum with underlying type: string
type ListRulesSortOrderEnum string
Set of constants representing the allowable values for ListRulesSortOrderEnum
const (
ListRulesSortOrderAsc ListRulesSortOrderEnum = "ASC"
ListRulesSortOrderDesc ListRulesSortOrderEnum = "DESC"
)
func GetListRulesSortOrderEnumValues() []ListRulesSortOrderEnum
GetListRulesSortOrderEnumValues Enumerates the set of values for ListRulesSortOrderEnum
func GetMappingListRulesSortOrderEnum(val string) (ListRulesSortOrderEnum, bool)
GetMappingListRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTagsFieldsEnum Enum with underlying type: string
type ListTagsFieldsEnum string
Set of constants representing the allowable values for ListTagsFieldsEnum
const (
ListTagsFieldsKey ListTagsFieldsEnum = "key"
ListTagsFieldsDisplayname ListTagsFieldsEnum = "displayName"
ListTagsFieldsDescription ListTagsFieldsEnum = "description"
ListTagsFieldsGlossarykey ListTagsFieldsEnum = "glossaryKey"
ListTagsFieldsParenttermkey ListTagsFieldsEnum = "parentTermKey"
ListTagsFieldsIsallowedtohavechildterms ListTagsFieldsEnum = "isAllowedToHaveChildTerms"
ListTagsFieldsPath ListTagsFieldsEnum = "path"
ListTagsFieldsLifecyclestate ListTagsFieldsEnum = "lifecycleState"
ListTagsFieldsTimecreated ListTagsFieldsEnum = "timeCreated"
ListTagsFieldsWorkflowstatus ListTagsFieldsEnum = "workflowStatus"
ListTagsFieldsAssociatedobjectcount ListTagsFieldsEnum = "associatedObjectCount"
ListTagsFieldsUri ListTagsFieldsEnum = "uri"
)
func GetListTagsFieldsEnumValues() []ListTagsFieldsEnum
GetListTagsFieldsEnumValues Enumerates the set of values for ListTagsFieldsEnum
func GetMappingListTagsFieldsEnum(val string) (ListTagsFieldsEnum, bool)
GetMappingListTagsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListTagsLifecycleStateEnum Enum with underlying type: string
type ListTagsLifecycleStateEnum string
Set of constants representing the allowable values for ListTagsLifecycleStateEnum
const (
ListTagsLifecycleStateCreating ListTagsLifecycleStateEnum = "CREATING"
ListTagsLifecycleStateActive ListTagsLifecycleStateEnum = "ACTIVE"
ListTagsLifecycleStateInactive ListTagsLifecycleStateEnum = "INACTIVE"
ListTagsLifecycleStateUpdating ListTagsLifecycleStateEnum = "UPDATING"
ListTagsLifecycleStateDeleting ListTagsLifecycleStateEnum = "DELETING"
ListTagsLifecycleStateDeleted ListTagsLifecycleStateEnum = "DELETED"
ListTagsLifecycleStateFailed ListTagsLifecycleStateEnum = "FAILED"
ListTagsLifecycleStateMoving ListTagsLifecycleStateEnum = "MOVING"
)
func GetListTagsLifecycleStateEnumValues() []ListTagsLifecycleStateEnum
GetListTagsLifecycleStateEnumValues Enumerates the set of values for ListTagsLifecycleStateEnum
func GetMappingListTagsLifecycleStateEnum(val string) (ListTagsLifecycleStateEnum, bool)
GetMappingListTagsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListTagsRequest wrapper for the ListTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTags.go.html to see an example of how to use ListTagsRequest.
type ListTagsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListTagsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Specifies the fields to return in a term summary response.
Fields []ListTagsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListTagsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListTagsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTagsRequest) String() string
func (request ListTagsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTagsResponse wrapper for the ListTags operation
type ListTagsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TermCollection instances
TermCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTagsResponse) String() string
ListTagsSortByEnum Enum with underlying type: string
type ListTagsSortByEnum string
Set of constants representing the allowable values for ListTagsSortByEnum
const (
ListTagsSortByTimecreated ListTagsSortByEnum = "TIMECREATED"
ListTagsSortByDisplayname ListTagsSortByEnum = "DISPLAYNAME"
)
func GetListTagsSortByEnumValues() []ListTagsSortByEnum
GetListTagsSortByEnumValues Enumerates the set of values for ListTagsSortByEnum
func GetMappingListTagsSortByEnum(val string) (ListTagsSortByEnum, bool)
GetMappingListTagsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTagsSortOrderEnum Enum with underlying type: string
type ListTagsSortOrderEnum string
Set of constants representing the allowable values for ListTagsSortOrderEnum
const (
ListTagsSortOrderAsc ListTagsSortOrderEnum = "ASC"
ListTagsSortOrderDesc ListTagsSortOrderEnum = "DESC"
)
func GetListTagsSortOrderEnumValues() []ListTagsSortOrderEnum
GetListTagsSortOrderEnumValues Enumerates the set of values for ListTagsSortOrderEnum
func GetMappingListTagsSortOrderEnum(val string) (ListTagsSortOrderEnum, bool)
GetMappingListTagsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermRelationshipsFieldsEnum Enum with underlying type: string
type ListTermRelationshipsFieldsEnum string
Set of constants representing the allowable values for ListTermRelationshipsFieldsEnum
const (
ListTermRelationshipsFieldsKey ListTermRelationshipsFieldsEnum = "key"
ListTermRelationshipsFieldsDisplayname ListTermRelationshipsFieldsEnum = "displayName"
ListTermRelationshipsFieldsDescription ListTermRelationshipsFieldsEnum = "description"
ListTermRelationshipsFieldsRelatedtermkey ListTermRelationshipsFieldsEnum = "relatedTermKey"
ListTermRelationshipsFieldsRelatedtermdisplayname ListTermRelationshipsFieldsEnum = "relatedTermDisplayName"
ListTermRelationshipsFieldsParenttermkey ListTermRelationshipsFieldsEnum = "parentTermKey"
ListTermRelationshipsFieldsParenttermdisplayname ListTermRelationshipsFieldsEnum = "parentTermDisplayName"
ListTermRelationshipsFieldsLifecyclestate ListTermRelationshipsFieldsEnum = "lifecycleState"
ListTermRelationshipsFieldsTimecreated ListTermRelationshipsFieldsEnum = "timeCreated"
ListTermRelationshipsFieldsUri ListTermRelationshipsFieldsEnum = "uri"
)
func GetListTermRelationshipsFieldsEnumValues() []ListTermRelationshipsFieldsEnum
GetListTermRelationshipsFieldsEnumValues Enumerates the set of values for ListTermRelationshipsFieldsEnum
func GetMappingListTermRelationshipsFieldsEnum(val string) (ListTermRelationshipsFieldsEnum, bool)
GetMappingListTermRelationshipsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermRelationshipsLifecycleStateEnum Enum with underlying type: string
type ListTermRelationshipsLifecycleStateEnum string
Set of constants representing the allowable values for ListTermRelationshipsLifecycleStateEnum
const (
ListTermRelationshipsLifecycleStateCreating ListTermRelationshipsLifecycleStateEnum = "CREATING"
ListTermRelationshipsLifecycleStateActive ListTermRelationshipsLifecycleStateEnum = "ACTIVE"
ListTermRelationshipsLifecycleStateInactive ListTermRelationshipsLifecycleStateEnum = "INACTIVE"
ListTermRelationshipsLifecycleStateUpdating ListTermRelationshipsLifecycleStateEnum = "UPDATING"
ListTermRelationshipsLifecycleStateDeleting ListTermRelationshipsLifecycleStateEnum = "DELETING"
ListTermRelationshipsLifecycleStateDeleted ListTermRelationshipsLifecycleStateEnum = "DELETED"
ListTermRelationshipsLifecycleStateFailed ListTermRelationshipsLifecycleStateEnum = "FAILED"
ListTermRelationshipsLifecycleStateMoving ListTermRelationshipsLifecycleStateEnum = "MOVING"
)
func GetListTermRelationshipsLifecycleStateEnumValues() []ListTermRelationshipsLifecycleStateEnum
GetListTermRelationshipsLifecycleStateEnumValues Enumerates the set of values for ListTermRelationshipsLifecycleStateEnum
func GetMappingListTermRelationshipsLifecycleStateEnum(val string) (ListTermRelationshipsLifecycleStateEnum, bool)
GetMappingListTermRelationshipsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermRelationshipsRequest wrapper for the ListTermRelationships operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTermRelationships.go.html to see an example of how to use ListTermRelationshipsRequest.
type ListTermRelationshipsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListTermRelationshipsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Specifies the fields to return in a term relationship summary response.
Fields []ListTermRelationshipsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListTermRelationshipsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListTermRelationshipsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListTermRelationshipsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTermRelationshipsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTermRelationshipsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTermRelationshipsRequest) String() string
func (request ListTermRelationshipsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTermRelationshipsResponse wrapper for the ListTermRelationships operation
type ListTermRelationshipsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TermRelationshipCollection instances
TermRelationshipCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListTermRelationshipsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTermRelationshipsResponse) String() string
ListTermRelationshipsSortByEnum Enum with underlying type: string
type ListTermRelationshipsSortByEnum string
Set of constants representing the allowable values for ListTermRelationshipsSortByEnum
const (
ListTermRelationshipsSortByTimecreated ListTermRelationshipsSortByEnum = "TIMECREATED"
ListTermRelationshipsSortByDisplayname ListTermRelationshipsSortByEnum = "DISPLAYNAME"
)
func GetListTermRelationshipsSortByEnumValues() []ListTermRelationshipsSortByEnum
GetListTermRelationshipsSortByEnumValues Enumerates the set of values for ListTermRelationshipsSortByEnum
func GetMappingListTermRelationshipsSortByEnum(val string) (ListTermRelationshipsSortByEnum, bool)
GetMappingListTermRelationshipsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermRelationshipsSortOrderEnum Enum with underlying type: string
type ListTermRelationshipsSortOrderEnum string
Set of constants representing the allowable values for ListTermRelationshipsSortOrderEnum
const (
ListTermRelationshipsSortOrderAsc ListTermRelationshipsSortOrderEnum = "ASC"
ListTermRelationshipsSortOrderDesc ListTermRelationshipsSortOrderEnum = "DESC"
)
func GetListTermRelationshipsSortOrderEnumValues() []ListTermRelationshipsSortOrderEnum
GetListTermRelationshipsSortOrderEnumValues Enumerates the set of values for ListTermRelationshipsSortOrderEnum
func GetMappingListTermRelationshipsSortOrderEnum(val string) (ListTermRelationshipsSortOrderEnum, bool)
GetMappingListTermRelationshipsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermsFieldsEnum Enum with underlying type: string
type ListTermsFieldsEnum string
Set of constants representing the allowable values for ListTermsFieldsEnum
const (
ListTermsFieldsKey ListTermsFieldsEnum = "key"
ListTermsFieldsDisplayname ListTermsFieldsEnum = "displayName"
ListTermsFieldsDescription ListTermsFieldsEnum = "description"
ListTermsFieldsGlossarykey ListTermsFieldsEnum = "glossaryKey"
ListTermsFieldsParenttermkey ListTermsFieldsEnum = "parentTermKey"
ListTermsFieldsIsallowedtohavechildterms ListTermsFieldsEnum = "isAllowedToHaveChildTerms"
ListTermsFieldsPath ListTermsFieldsEnum = "path"
ListTermsFieldsLifecyclestate ListTermsFieldsEnum = "lifecycleState"
ListTermsFieldsTimecreated ListTermsFieldsEnum = "timeCreated"
ListTermsFieldsWorkflowstatus ListTermsFieldsEnum = "workflowStatus"
ListTermsFieldsAssociatedobjectcount ListTermsFieldsEnum = "associatedObjectCount"
ListTermsFieldsUri ListTermsFieldsEnum = "uri"
)
func GetListTermsFieldsEnumValues() []ListTermsFieldsEnum
GetListTermsFieldsEnumValues Enumerates the set of values for ListTermsFieldsEnum
func GetMappingListTermsFieldsEnum(val string) (ListTermsFieldsEnum, bool)
GetMappingListTermsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermsLifecycleStateEnum Enum with underlying type: string
type ListTermsLifecycleStateEnum string
Set of constants representing the allowable values for ListTermsLifecycleStateEnum
const (
ListTermsLifecycleStateCreating ListTermsLifecycleStateEnum = "CREATING"
ListTermsLifecycleStateActive ListTermsLifecycleStateEnum = "ACTIVE"
ListTermsLifecycleStateInactive ListTermsLifecycleStateEnum = "INACTIVE"
ListTermsLifecycleStateUpdating ListTermsLifecycleStateEnum = "UPDATING"
ListTermsLifecycleStateDeleting ListTermsLifecycleStateEnum = "DELETING"
ListTermsLifecycleStateDeleted ListTermsLifecycleStateEnum = "DELETED"
ListTermsLifecycleStateFailed ListTermsLifecycleStateEnum = "FAILED"
ListTermsLifecycleStateMoving ListTermsLifecycleStateEnum = "MOVING"
)
func GetListTermsLifecycleStateEnumValues() []ListTermsLifecycleStateEnum
GetListTermsLifecycleStateEnumValues Enumerates the set of values for ListTermsLifecycleStateEnum
func GetMappingListTermsLifecycleStateEnum(val string) (ListTermsLifecycleStateEnum, bool)
GetMappingListTermsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermsRequest wrapper for the ListTerms operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTerms.go.html to see an example of how to use ListTermsRequest.
type ListTermsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListTermsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique key of the parent term.
ParentTermKey *string `mandatory:"false" contributesTo:"query" name:"parentTermKey"`
// Indicates whether a term may contain child terms.
IsAllowedToHaveChildTerms *bool `mandatory:"false" contributesTo:"query" name:"isAllowedToHaveChildTerms"`
// Status of the approval workflow for this business term in the glossary.
WorkflowStatus ListTermsWorkflowStatusEnum `mandatory:"false" contributesTo:"query" name:"workflowStatus" omitEmpty:"true"`
// Full path of the resource for resources that support paths.
Path *string `mandatory:"false" contributesTo:"query" name:"path"`
// Specifies the fields to return in a term summary response.
Fields []ListTermsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListTermsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListTermsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListTermsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTermsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTermsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTermsRequest) String() string
func (request ListTermsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTermsResponse wrapper for the ListTerms operation
type ListTermsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TermCollection instances
TermCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListTermsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTermsResponse) String() string
ListTermsSortByEnum Enum with underlying type: string
type ListTermsSortByEnum string
Set of constants representing the allowable values for ListTermsSortByEnum
const (
ListTermsSortByTimecreated ListTermsSortByEnum = "TIMECREATED"
ListTermsSortByDisplayname ListTermsSortByEnum = "DISPLAYNAME"
)
func GetListTermsSortByEnumValues() []ListTermsSortByEnum
GetListTermsSortByEnumValues Enumerates the set of values for ListTermsSortByEnum
func GetMappingListTermsSortByEnum(val string) (ListTermsSortByEnum, bool)
GetMappingListTermsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermsSortOrderEnum Enum with underlying type: string
type ListTermsSortOrderEnum string
Set of constants representing the allowable values for ListTermsSortOrderEnum
const (
ListTermsSortOrderAsc ListTermsSortOrderEnum = "ASC"
ListTermsSortOrderDesc ListTermsSortOrderEnum = "DESC"
)
func GetListTermsSortOrderEnumValues() []ListTermsSortOrderEnum
GetListTermsSortOrderEnumValues Enumerates the set of values for ListTermsSortOrderEnum
func GetMappingListTermsSortOrderEnum(val string) (ListTermsSortOrderEnum, bool)
GetMappingListTermsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTermsWorkflowStatusEnum Enum with underlying type: string
type ListTermsWorkflowStatusEnum string
Set of constants representing the allowable values for ListTermsWorkflowStatusEnum
const (
ListTermsWorkflowStatusNew ListTermsWorkflowStatusEnum = "NEW"
ListTermsWorkflowStatusApproved ListTermsWorkflowStatusEnum = "APPROVED"
ListTermsWorkflowStatusUnderReview ListTermsWorkflowStatusEnum = "UNDER_REVIEW"
ListTermsWorkflowStatusEscalated ListTermsWorkflowStatusEnum = "ESCALATED"
)
func GetListTermsWorkflowStatusEnumValues() []ListTermsWorkflowStatusEnum
GetListTermsWorkflowStatusEnumValues Enumerates the set of values for ListTermsWorkflowStatusEnum
func GetMappingListTermsWorkflowStatusEnum(val string) (ListTermsWorkflowStatusEnum, bool)
GetMappingListTermsWorkflowStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListTypesFieldsEnum Enum with underlying type: string
type ListTypesFieldsEnum string
Set of constants representing the allowable values for ListTypesFieldsEnum
const (
ListTypesFieldsKey ListTypesFieldsEnum = "key"
ListTypesFieldsDescription ListTypesFieldsEnum = "description"
ListTypesFieldsName ListTypesFieldsEnum = "name"
ListTypesFieldsCatalogid ListTypesFieldsEnum = "catalogId"
ListTypesFieldsLifecyclestate ListTypesFieldsEnum = "lifecycleState"
ListTypesFieldsTypecategory ListTypesFieldsEnum = "typeCategory"
ListTypesFieldsUri ListTypesFieldsEnum = "uri"
)
func GetListTypesFieldsEnumValues() []ListTypesFieldsEnum
GetListTypesFieldsEnumValues Enumerates the set of values for ListTypesFieldsEnum
func GetMappingListTypesFieldsEnum(val string) (ListTypesFieldsEnum, bool)
GetMappingListTypesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListTypesLifecycleStateEnum Enum with underlying type: string
type ListTypesLifecycleStateEnum string
Set of constants representing the allowable values for ListTypesLifecycleStateEnum
const (
ListTypesLifecycleStateCreating ListTypesLifecycleStateEnum = "CREATING"
ListTypesLifecycleStateActive ListTypesLifecycleStateEnum = "ACTIVE"
ListTypesLifecycleStateInactive ListTypesLifecycleStateEnum = "INACTIVE"
ListTypesLifecycleStateUpdating ListTypesLifecycleStateEnum = "UPDATING"
ListTypesLifecycleStateDeleting ListTypesLifecycleStateEnum = "DELETING"
ListTypesLifecycleStateDeleted ListTypesLifecycleStateEnum = "DELETED"
ListTypesLifecycleStateFailed ListTypesLifecycleStateEnum = "FAILED"
ListTypesLifecycleStateMoving ListTypesLifecycleStateEnum = "MOVING"
)
func GetListTypesLifecycleStateEnumValues() []ListTypesLifecycleStateEnum
GetListTypesLifecycleStateEnumValues Enumerates the set of values for ListTypesLifecycleStateEnum
func GetMappingListTypesLifecycleStateEnum(val string) (ListTypesLifecycleStateEnum, bool)
GetMappingListTypesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListTypesRequest wrapper for the ListTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTypes.go.html to see an example of how to use ListTypesRequest.
type ListTypesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Immutable resource name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListTypesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsInternal *string `mandatory:"false" contributesTo:"query" name:"isInternal"`
// Indicates whether the type can be used for tagging metadata elements.
IsTag *string `mandatory:"false" contributesTo:"query" name:"isTag"`
// Indicates whether the type is approved for use as a classifying object.
IsApproved *string `mandatory:"false" contributesTo:"query" name:"isApproved"`
// Data type as defined in an external system.
ExternalTypeName *string `mandatory:"false" contributesTo:"query" name:"externalTypeName"`
// Indicates the category of this type . For example, data assets or connections.
TypeCategory *string `mandatory:"false" contributesTo:"query" name:"typeCategory"`
// Specifies the fields to return in a type summary response.
Fields []ListTypesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ListTypesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListTypesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTypesRequest) String() string
func (request ListTypesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTypesResponse wrapper for the ListTypes operation
type ListTypesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TypeCollection instances
TypeCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTypesResponse) String() string
ListTypesSortByEnum Enum with underlying type: string
type ListTypesSortByEnum string
Set of constants representing the allowable values for ListTypesSortByEnum
const (
ListTypesSortByTimecreated ListTypesSortByEnum = "TIMECREATED"
ListTypesSortByDisplayname ListTypesSortByEnum = "DISPLAYNAME"
)
func GetListTypesSortByEnumValues() []ListTypesSortByEnum
GetListTypesSortByEnumValues Enumerates the set of values for ListTypesSortByEnum
func GetMappingListTypesSortByEnum(val string) (ListTypesSortByEnum, bool)
GetMappingListTypesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTypesSortOrderEnum Enum with underlying type: string
type ListTypesSortOrderEnum string
Set of constants representing the allowable values for ListTypesSortOrderEnum
const (
ListTypesSortOrderAsc ListTypesSortOrderEnum = "ASC"
ListTypesSortOrderDesc ListTypesSortOrderEnum = "DESC"
)
func GetListTypesSortOrderEnumValues() []ListTypesSortOrderEnum
GetListTypesSortOrderEnumValues Enumerates the set of values for ListTypesSortOrderEnum
func GetMappingListTypesSortOrderEnum(val string) (ListTypesSortOrderEnum, bool)
GetMappingListTypesSortOrderEnum 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/datacatalog/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID 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"`
// The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for CODE and MESSAGE is ascending. If no value is specified TIMESTAMP is default.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestErrorsSortOrderEnum `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 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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByCode ListWorkRequestErrorsSortByEnum = "CODE"
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "TIMESTAMP"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID 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"`
// The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for MESSAGE is ascending. If no value is specified TIMESTAMP is default.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestLogsSortOrderEnum `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 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 []WorkRequestLog instances
Items []WorkRequestLog `presentIn:"body"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByMessage ListWorkRequestLogsSortByEnum = "MESSAGE"
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "TIMESTAMP"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID of the compartment where you want to list resources.
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 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"`
// 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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
Metastore A Data Catalog Metastore provides a centralized metastore repository for use by other OCI services.
type Metastore struct {
// The metastore's OCID.
Id *string `mandatory:"true" json:"id"`
// OCID of the compartment which holds the metastore.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Location under which managed tables will be created by default. This references Object Storage
// using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
DefaultManagedTableLocation *string `mandatory:"true" json:"defaultManagedTableLocation"`
// Location under which external tables will be created by default. This references Object Storage
// using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
DefaultExternalTableLocation *string `mandatory:"true" json:"defaultExternalTableLocation"`
// Mutable name of the metastore.
DisplayName *string `mandatory:"false" json:"displayName"`
// Time at which the metastore was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time at which the metastore was last modified. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the metastore.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// System tags can be viewed by users, but can only be created by the system.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// 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"`
}
func (m Metastore) String() string
func (m Metastore) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MetastoreSummary Summary of a metastore.
type MetastoreSummary struct {
// The metastore's OCID.
Id *string `mandatory:"true" json:"id"`
// OCID of the compartment which holds the metastore.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Mutable name of the metastore.
DisplayName *string `mandatory:"false" json:"displayName"`
// Time at which the metastore was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time at which the metastore was last modified. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the metastore.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// System tags can be viewed by users, but can only be created by the system.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// 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"`
}
func (m MetastoreSummary) String() string
func (m MetastoreSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ModelType Full data catalog type definition. Fully defines a type of the data catalog. All types are statically defined in the system and are immutable. It isn't possible to create new types or update existing types via the API.
type ModelType struct {
// Unique type key that is immutable.
Key *string `mandatory:"true" json:"key"`
// The immutable name of the type.
Name *string `mandatory:"false" json:"name"`
// Detailed description of the type.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// A map of arrays which defines the type specific properties, both required and optional. The map keys are
// category names and the values are arrays contiaing all property details. Every property is contained inside
// of a category. Most types have required properties within the "default" category.
// Example:
// `{
// "properties": {
// "default": {
// "attributes:": [
// {
// "name": "host",
// "type": "string",
// "isRequired": true,
// "isUpdatable": false
// },
// ...
// ]
// }
// }
// }`
Properties map[string][]PropertyDefinition `mandatory:"false" json:"properties"`
// The current state of the type.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsInternal *bool `mandatory:"false" json:"isInternal"`
// Indicates whether the type can be used for tagging metadata elements.
IsTag *bool `mandatory:"false" json:"isTag"`
// Indicates whether the type is approved for use as a classifying object.
IsApproved *bool `mandatory:"false" json:"isApproved"`
// Indicates the category this type belongs to. For instance, data assets, connections.
TypeCategory *string `mandatory:"false" json:"typeCategory"`
// Mapping type equivalence in the external system.
ExternalTypeName *string `mandatory:"false" json:"externalTypeName"`
// URI to the type instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Custom properties associated with this Type.
CustomProperties []CustomPropertySummary `mandatory:"false" json:"customProperties"`
// Unique key of the parent type.
ParentTypeKey *string `mandatory:"false" json:"parentTypeKey"`
// Name of the parent type.
ParentTypeName *string `mandatory:"false" json:"parentTypeName"`
}
func (m ModelType) String() string
func (m ModelType) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Namespace Namespace Definition
type Namespace struct {
// Unique namespace key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Name of the Namespace
DisplayName *string `mandatory:"false" json:"displayName"`
// Description for the namespace
Description *string `mandatory:"false" json:"description"`
// If this field is defined by service or by a user
IsServiceDefined *bool `mandatory:"false" json:"isServiceDefined"`
// The current state of the namespace.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the namespace was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the namespace. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the namespace.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who last modified the namespace.
UpdatedById *string `mandatory:"false" json:"updatedById"`
}
func (m Namespace) String() string
func (m Namespace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NamespaceCollection Results of a namespaces listing. A namespace is an unique name tied to the first class object of data catalog which will be used to create a custom property
type NamespaceCollection struct {
// Collection of namespace summaries
Items []NamespaceSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m NamespaceCollection) String() string
func (m NamespaceCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NamespaceSummary Summary of a namespace
type NamespaceSummary struct {
// Unique namespace key that is immutable.
Key *string `mandatory:"true" json:"key"`
// Name of the namespace
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the namespace.
Description *string `mandatory:"false" json:"description"`
// If this field is defined by service or by a user
IsServiceDefined *bool `mandatory:"false" json:"isServiceDefined"`
// The current state of the namespace.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the namespace was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m NamespaceSummary) String() string
func (m NamespaceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectLineage Lineage for an object.
type ObjectLineage struct {
// Object level at which the lineage is returned.
Level *int `mandatory:"true" json:"level"`
// Direction of the lineage returned.
Direction LineageDirectionEnum `mandatory:"true" json:"direction"`
// Set of objects that are involved in the lineage.
Objects []LineageObject `mandatory:"false" json:"objects"`
// Set of relationships between the objects in the 'objects' set.
Relationships []LineageRelationship `mandatory:"false" json:"relationships"`
// A map of maps that contains additional information in explanation of the lineage returned. The map keys are
// categories of information and the values are maps of annotation names to their corresponding values.
// Every annotation is contained inside a category.
// Example: `{"annotations": { "category": { "key": "value"}}}`
Annotations map[string]map[string]string `mandatory:"false" json:"annotations"`
}
func (m ObjectLineage) String() string
func (m ObjectLineage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectLineageRequestDetails Details needed by a lineage fetch request.
type ObjectLineageRequestDetails struct {
// Object level at which the lineage is returned.
Level *int `mandatory:"false" json:"level"`
// Direction of the lineage returned.
Direction LineageDirectionEnum `mandatory:"false" json:"direction,omitempty"`
// Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be
// expanded inline in the lineage returned.
IsIntraLineage *bool `mandatory:"false" json:"isIntraLineage"`
// Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding
// to the object whose object key is passed is returned.
IntraLineageObjectKey *string `mandatory:"false" json:"intraLineageObjectKey"`
}
func (m ObjectLineageRequestDetails) String() string
func (m ObjectLineageRequestDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectRelationship Details regarding a specific object and its relationship to the referencing object.
type ObjectRelationship struct {
// Type of relationship with the referencing object.
RelationshipType *string `mandatory:"false" json:"relationshipType"`
// Unique id of the object.
Key *string `mandatory:"false" json:"key"`
// Name of the object.
Name *string `mandatory:"false" json:"name"`
// Type name of the object. Type names can be found via the '/types' endpoint.
TypeName *string `mandatory:"false" json:"typeName"`
// Type key of the object. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// The date and time the relationship was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time a change was made to this reference. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Full path of the object.
Path *string `mandatory:"false" json:"path"`
// Key of the parent object for the resource.
ParentKey *string `mandatory:"false" json:"parentKey"`
// Full path of the parent object.
ParentPath *string `mandatory:"false" json:"parentPath"`
}
func (m ObjectRelationship) String() string
func (m ObjectRelationship) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectStatsRequest wrapper for the ObjectStats operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ObjectStats.go.html to see an example of how to use ObjectStatsRequest.
type ObjectStatsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy ObjectStatsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ObjectStatsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ObjectStatsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ObjectStatsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ObjectStatsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ObjectStatsRequest) String() string
func (request ObjectStatsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectStatsResponse wrapper for the ObjectStats operation
type ObjectStatsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of string instances
Value *string `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ObjectStatsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ObjectStatsResponse) String() string
ObjectStatsSortByEnum Enum with underlying type: string
type ObjectStatsSortByEnum string
Set of constants representing the allowable values for ObjectStatsSortByEnum
const (
ObjectStatsSortByTimecreated ObjectStatsSortByEnum = "TIMECREATED"
ObjectStatsSortByDisplayname ObjectStatsSortByEnum = "DISPLAYNAME"
)
func GetMappingObjectStatsSortByEnum(val string) (ObjectStatsSortByEnum, bool)
GetMappingObjectStatsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetObjectStatsSortByEnumValues() []ObjectStatsSortByEnum
GetObjectStatsSortByEnumValues Enumerates the set of values for ObjectStatsSortByEnum
ObjectStatsSortOrderEnum Enum with underlying type: string
type ObjectStatsSortOrderEnum string
Set of constants representing the allowable values for ObjectStatsSortOrderEnum
const (
ObjectStatsSortOrderAsc ObjectStatsSortOrderEnum = "ASC"
ObjectStatsSortOrderDesc ObjectStatsSortOrderEnum = "DESC"
)
func GetMappingObjectStatsSortOrderEnum(val string) (ObjectStatsSortOrderEnum, bool)
GetMappingObjectStatsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetObjectStatsSortOrderEnumValues() []ObjectStatsSortOrderEnum
GetObjectStatsSortOrderEnumValues Enumerates the set of values for ObjectStatsSortOrderEnum
ObjectStorageObjectReference A reference to an Object Storage object.
type ObjectStorageObjectReference struct {
// Object Storage namespace.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// Object Storage object name.
ObjectName *string `mandatory:"true" json:"objectName"`
}
func (m ObjectStorageObjectReference) String() string
func (m ObjectStorageObjectReference) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ParseConnectionDetails Parse connections from the connection metadata and Oracle wallet file. An error will be returned if more than one of connectionPayload, walletSecretId or walletSecretName are present in the request.
type ParseConnectionDetails struct {
ConnectionDetail *Connection `mandatory:"false" json:"connectionDetail"`
// The information used to parse the connection from the wallet file payload.
ConnectionPayload []byte `mandatory:"false" json:"connectionPayload"`
// OCID of the OCI Vault secret holding the Oracle wallet to parse.
WalletSecretId *string `mandatory:"false" json:"walletSecretId"`
// Name of the OCI Vault secret holding the Oracle wallet to parse.
WalletSecretName *string `mandatory:"false" json:"walletSecretName"`
}
func (m ParseConnectionDetails) String() string
func (m ParseConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ParseConnectionRequest wrapper for the ParseConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ParseConnection.go.html to see an example of how to use ParseConnectionRequest.
type ParseConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to parse the connections from payload or connection detail.
ParseConnectionDetails `contributesTo:"body"`
// Unique connection key.
ConnectionKey *string `mandatory:"false" contributesTo:"query" name:"connectionKey"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ParseConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ParseConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ParseConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ParseConnectionRequest) String() string
func (request ParseConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ParseConnectionResponse wrapper for the ParseConnection operation
type ParseConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// The []ConnectionAliasSummary instance
Items []ConnectionAliasSummary `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response ParseConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ParseConnectionResponse) String() string
Pattern A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.
type Pattern struct {
// Unique pattern key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the pattern.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// The current state of the pattern.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the pattern was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the pattern. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the pattern.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who last modified the pattern.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Input string which drives the selection process, allowing for fine-grained control using qualifiers.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
Expression *string `mandatory:"false" json:"expression"`
// Input string which drives the selection process.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
FilePathPrefix *string `mandatory:"false" json:"filePathPrefix"`
// List of file paths against which the pattern can be tried, as a check. This documents, for reference
// purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true,
// this will be run as a validation during the request, such that if the check fails the request fails. If
// isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even
// if the check fails, with a lifecycleState of FAILED.
CheckFilePathList []string `mandatory:"false" json:"checkFilePathList"`
// Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of
// UNMATCHED files is above the checkFailureLimit.
IsEnableCheckFailureLimit *bool `mandatory:"false" json:"isEnableCheckFailureLimit"`
// The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if
// checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.
CheckFailureLimit *int `mandatory:"false" json:"checkFailureLimit"`
// A map of maps that contains the properties which are specific to the pattern type. Each pattern type
// definition defines it's set of required and optional properties.
// Example: `{"properties": { "default": { "tbd"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m Pattern) String() string
func (m Pattern) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatternCollection Results of a pattern listing. Patterns are used in entity harvesting.
type PatternCollection struct {
// Collection of pattern summaries.
Items []PatternSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m PatternCollection) String() string
func (m PatternCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatternSummary Summary of a pattern. A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.
type PatternSummary struct {
// Unique pattern key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the pattern.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// The date and time the pattern was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Input string which drives the selection process, allowing for fine-grained control using qualifiers.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
Expression *string `mandatory:"false" json:"expression"`
// Input string which drives the selection process.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
FilePathPrefix *string `mandatory:"false" json:"filePathPrefix"`
// State of the pattern.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m PatternSummary) String() string
func (m PatternSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProcessRecommendationDetails Details of recommendation to be processed.
type ProcessRecommendationDetails struct {
// Unique identifier of the recommendation.
RecommendationKey *string `mandatory:"true" json:"recommendationKey"`
// The status of a recommendation.
RecommendationStatus RecommendationStatusEnum `mandatory:"true" json:"recommendationStatus"`
// A map of maps that contains additional properties which are specific to the associated objects.
// Each associated object defines it's set of required and optional properties.
// Example: `{
// "DataEntity": {
// "parentId": "entityId"
// },
// "Term": {
// "parentId": "glossaryId"
// }
// }`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m ProcessRecommendationDetails) String() string
func (m ProcessRecommendationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProcessRecommendationRequest wrapper for the ProcessRecommendation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ProcessRecommendation.go.html to see an example of how to use ProcessRecommendationRequest.
type ProcessRecommendationRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Recommendation to be processed.
ProcessRecommendationDetails `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 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"`
// 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 ProcessRecommendationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ProcessRecommendationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ProcessRecommendationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ProcessRecommendationRequest) String() string
func (request ProcessRecommendationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProcessRecommendationResponse wrapper for the ProcessRecommendation operation
type ProcessRecommendationResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProcessRecommendationDetails instance
ProcessRecommendationDetails `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response ProcessRecommendationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ProcessRecommendationResponse) String() string
PropertyDefinition Details of a single type property.
type PropertyDefinition struct {
// Name of the property.
Name *string `mandatory:"false" json:"name"`
// The properties value type.
Type *string `mandatory:"false" json:"type"`
// Whether instances of the type are required to set this property.
IsRequired *bool `mandatory:"false" json:"isRequired"`
// Indicates if this property value can be updated.
IsUpdatable *bool `mandatory:"false" json:"isUpdatable"`
}
func (m PropertyDefinition) String() string
func (m PropertyDefinition) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecommendationCollection Results of a get recommendation.
type RecommendationCollection struct {
// Collection of recommendations.
Items []RecommendationDetails `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m RecommendationCollection) String() string
func (m RecommendationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecommendationDetails Details of a recommendation.
type RecommendationDetails struct {
// Unique identifier of the recommendation.
RecommendationKey *string `mandatory:"true" json:"recommendationKey"`
// Type of recommendation.
RecommendationType RecommendationTypeEnum `mandatory:"true" json:"recommendationType"`
// Status of a recommendation.
RecommendationStatus RecommendationStatusEnum `mandatory:"true" json:"recommendationStatus"`
// Level of confidence, on a scale between 0 and 1, that the recommendation is applicable.
ConfidenceScore *float32 `mandatory:"false" json:"confidenceScore"`
// Unique identifier of the source object; the one for which a recommendation is made.
SourceObjectKey *string `mandatory:"false" json:"sourceObjectKey"`
// Name of the source object; the one for which a recommendation is made.
SourceObjectName *string `mandatory:"false" json:"sourceObjectName"`
// Type of the source object; the one for which a recommendation is made.
SourceObjectType RecommendationResourceTypeEnum `mandatory:"false" json:"sourceObjectType,omitempty"`
// Unique identifier of the target object; the one which has been recommended.
TargetObjectKey *string `mandatory:"false" json:"targetObjectKey"`
// Name of the target object; the one which has been recommended.
TargetObjectName *string `mandatory:"false" json:"targetObjectName"`
// Type of the target object; the one which has been recommended.
TargetObjectType RecommendationResourceTypeEnum `mandatory:"false" json:"targetObjectType,omitempty"`
// A map of maps that contains additional properties which are specific to the associated objects.
// Each associated object defines it's set of required and optional properties.
// Example: `{
// "DataEntity": {
// "parentId": "entityId"
// },
// "Term": {
// "parentId": "glossaryId"
// }
// }`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m RecommendationDetails) String() string
func (m RecommendationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecommendationResourceTypeEnum Enum with underlying type: string
type RecommendationResourceTypeEnum string
Set of constants representing the allowable values for RecommendationResourceTypeEnum
const (
RecommendationResourceTypeDataEntity RecommendationResourceTypeEnum = "DATA_ENTITY"
RecommendationResourceTypeAttribute RecommendationResourceTypeEnum = "ATTRIBUTE"
RecommendationResourceTypeTerm RecommendationResourceTypeEnum = "TERM"
RecommendationResourceTypeCategory RecommendationResourceTypeEnum = "CATEGORY"
)
func GetMappingRecommendationResourceTypeEnum(val string) (RecommendationResourceTypeEnum, bool)
GetMappingRecommendationResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecommendationResourceTypeEnumValues() []RecommendationResourceTypeEnum
GetRecommendationResourceTypeEnumValues Enumerates the set of values for RecommendationResourceTypeEnum
RecommendationStatusEnum Enum with underlying type: string
type RecommendationStatusEnum string
Set of constants representing the allowable values for RecommendationStatusEnum
const (
RecommendationStatusAccepted RecommendationStatusEnum = "ACCEPTED"
RecommendationStatusRejected RecommendationStatusEnum = "REJECTED"
RecommendationStatusInferred RecommendationStatusEnum = "INFERRED"
)
func GetMappingRecommendationStatusEnum(val string) (RecommendationStatusEnum, bool)
GetMappingRecommendationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecommendationStatusEnumValues() []RecommendationStatusEnum
GetRecommendationStatusEnumValues Enumerates the set of values for RecommendationStatusEnum
RecommendationTypeEnum Enum with underlying type: string
type RecommendationTypeEnum string
Set of constants representing the allowable values for RecommendationTypeEnum
const (
RecommendationTypeLinkGlossaryTerm RecommendationTypeEnum = "LINK_GLOSSARY_TERM"
)
func GetMappingRecommendationTypeEnum(val string) (RecommendationTypeEnum, bool)
GetMappingRecommendationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecommendationTypeEnumValues() []RecommendationTypeEnum
GetRecommendationTypeEnumValues Enumerates the set of values for RecommendationTypeEnum
RecommendationsRecommendationStatusEnum Enum with underlying type: string
type RecommendationsRecommendationStatusEnum string
Set of constants representing the allowable values for RecommendationsRecommendationStatusEnum
const (
RecommendationsRecommendationStatusAccepted RecommendationsRecommendationStatusEnum = "ACCEPTED"
RecommendationsRecommendationStatusRejected RecommendationsRecommendationStatusEnum = "REJECTED"
RecommendationsRecommendationStatusInferred RecommendationsRecommendationStatusEnum = "INFERRED"
)
func GetMappingRecommendationsRecommendationStatusEnum(val string) (RecommendationsRecommendationStatusEnum, bool)
GetMappingRecommendationsRecommendationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecommendationsRecommendationStatusEnumValues() []RecommendationsRecommendationStatusEnum
GetRecommendationsRecommendationStatusEnumValues Enumerates the set of values for RecommendationsRecommendationStatusEnum
RecommendationsRequest wrapper for the Recommendations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/Recommendations.go.html to see an example of how to use RecommendationsRequest.
type RecommendationsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// A filter used to return only recommendations of the specified type.
RecommendationType []RecommendationTypeEnum `contributesTo:"query" name:"recommendationType" omitEmpty:"true" collectionFormat:"multi"`
// A filter used to provide the unique identifier of the source object, for which a list of recommendations will be returned for review.
SourceObjectKey *string `mandatory:"true" contributesTo:"query" name:"sourceObjectKey"`
// A filter used to provide the type of the source object, for which a list of recommendations will be returned for review.
SourceObjectType RecommendationsSourceObjectTypeEnum `mandatory:"true" contributesTo:"query" name:"sourceObjectType" omitEmpty:"true"`
// A filter used to return only recommendations having the requested status.
RecommendationStatus RecommendationsRecommendationStatusEnum `mandatory:"false" contributesTo:"query" name:"recommendationStatus" 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 RecommendationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RecommendationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RecommendationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RecommendationsRequest) String() string
func (request RecommendationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecommendationsResponse wrapper for the Recommendations operation
type RecommendationsResponse struct {
// The underlying http response
RawResponse *http.Response
// The RecommendationCollection instance
RecommendationCollection `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"`
}
func (response RecommendationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RecommendationsResponse) String() string
RecommendationsSourceObjectTypeEnum Enum with underlying type: string
type RecommendationsSourceObjectTypeEnum string
Set of constants representing the allowable values for RecommendationsSourceObjectTypeEnum
const (
RecommendationsSourceObjectTypeDataEntity RecommendationsSourceObjectTypeEnum = "DATA_ENTITY"
RecommendationsSourceObjectTypeAttribute RecommendationsSourceObjectTypeEnum = "ATTRIBUTE"
RecommendationsSourceObjectTypeTerm RecommendationsSourceObjectTypeEnum = "TERM"
RecommendationsSourceObjectTypeCategory RecommendationsSourceObjectTypeEnum = "CATEGORY"
)
func GetMappingRecommendationsSourceObjectTypeEnum(val string) (RecommendationsSourceObjectTypeEnum, bool)
GetMappingRecommendationsSourceObjectTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecommendationsSourceObjectTypeEnumValues() []RecommendationsSourceObjectTypeEnum
GetRecommendationsSourceObjectTypeEnumValues Enumerates the set of values for RecommendationsSourceObjectTypeEnum
RemoveCatalogLockRequest wrapper for the RemoveCatalogLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveCatalogLock.go.html to see an example of how to use RemoveCatalogLockRequest.
type RemoveCatalogLockRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// 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 RemoveCatalogLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveCatalogLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveCatalogLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveCatalogLockRequest) String() string
func (request RemoveCatalogLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveCatalogLockResponse wrapper for the RemoveCatalogLock operation
type RemoveCatalogLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Catalog instance
Catalog `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 Catalog resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RemoveCatalogLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveCatalogLockResponse) String() string
RemoveCatalogPrivateEndpointLockRequest wrapper for the RemoveCatalogPrivateEndpointLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveCatalogPrivateEndpointLock.go.html to see an example of how to use RemoveCatalogPrivateEndpointLockRequest.
type RemoveCatalogPrivateEndpointLockRequest struct {
// Unique private reverse connection identifier.
CatalogPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"catalogPrivateEndpointId"`
// 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 RemoveCatalogPrivateEndpointLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveCatalogPrivateEndpointLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveCatalogPrivateEndpointLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveCatalogPrivateEndpointLockRequest) String() string
func (request RemoveCatalogPrivateEndpointLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveCatalogPrivateEndpointLockResponse wrapper for the RemoveCatalogPrivateEndpointLock operation
type RemoveCatalogPrivateEndpointLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The CatalogPrivateEndpoint instance
CatalogPrivateEndpoint `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 CatalogPrivateEndpoint resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RemoveCatalogPrivateEndpointLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveCatalogPrivateEndpointLockResponse) String() string
RemoveDataSelectorPatternsRequest wrapper for the RemoveDataSelectorPatterns operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveDataSelectorPatterns.go.html to see an example of how to use RemoveDataSelectorPatternsRequest.
type RemoveDataSelectorPatternsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to remove the data selector patterns.
DataSelectorPatternDetails `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 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 RemoveDataSelectorPatternsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveDataSelectorPatternsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveDataSelectorPatternsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveDataSelectorPatternsRequest) String() string
func (request RemoveDataSelectorPatternsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveDataSelectorPatternsResponse wrapper for the RemoveDataSelectorPatterns operation
type RemoveDataSelectorPatternsResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataAsset instance
DataAsset `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response RemoveDataSelectorPatternsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveDataSelectorPatternsResponse) String() string
RemoveMetastoreLockRequest wrapper for the RemoveMetastoreLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/RemoveMetastoreLock.go.html to see an example of how to use RemoveMetastoreLockRequest.
type RemoveMetastoreLockRequest struct {
// The metastore's OCID.
MetastoreId *string `mandatory:"true" contributesTo:"path" name:"metastoreId"`
// 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 RemoveMetastoreLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveMetastoreLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveMetastoreLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveMetastoreLockRequest) String() string
func (request RemoveMetastoreLockRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RemoveMetastoreLockResponse wrapper for the RemoveMetastoreLock operation
type RemoveMetastoreLockResponse struct {
// The underlying http response
RawResponse *http.Response
// The Metastore instance
Metastore `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 Metastore resource.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RemoveMetastoreLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveMetastoreLockResponse) String() string
RemoveResourceLockDetails The representation of RemoveResourceLockDetails
type RemoveResourceLockDetails struct {
// Type of the lock.
Type RemoveResourceLockDetailsTypeEnum `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 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
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
RuleAttribute Object that defines a usage of an attribute in the context of a rule. Example: For a UNIQUEKEY rule, declares the attribute in a table whose value must be unique.
type RuleAttribute struct {
// Immutable unique key of the attribute.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" json:"position"`
}
func (m RuleAttribute) String() string
func (m RuleAttribute) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RuleCollection Results of an rule listing. Rules describe an item of data with name and ruletype.
type RuleCollection struct {
// Collection of rules.
Items []RuleSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m RuleCollection) String() string
func (m RuleCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RuleOriginTypeEnum Enum with underlying type: string
type RuleOriginTypeEnum string
Set of constants representing the allowable values for RuleOriginTypeEnum
const (
RuleOriginTypeSource RuleOriginTypeEnum = "SOURCE"
RuleOriginTypeUser RuleOriginTypeEnum = "USER"
RuleOriginTypeProfiling RuleOriginTypeEnum = "PROFILING"
)
func GetMappingRuleOriginTypeEnum(val string) (RuleOriginTypeEnum, bool)
GetMappingRuleOriginTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRuleOriginTypeEnumValues() []RuleOriginTypeEnum
GetRuleOriginTypeEnumValues Enumerates the set of values for RuleOriginTypeEnum
RuleSummary A list of rule resources. One or more rules can be defined for a data entity. Each rule can be defined on one or more attributes of the data entity.
type RuleSummary struct {
// Immutable unique key of a rule.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of a rule.
Description *string `mandatory:"false" json:"description"`
// Type of a rule.
RuleType RuleTypeEnum `mandatory:"false" json:"ruleType,omitempty"`
// External URI that can be used to reference the object. Format will differ based on the type of object.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Attributes associated with a rule.
// A UNIQUEKEY rule would contain (at least) one attribute, for the local table column(s) on which uniqueness is defined.
Attributes []RuleAttribute `mandatory:"false" json:"attributes"`
// Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.
ReferencedFolderKey *string `mandatory:"false" json:"referencedFolderKey"`
// Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.
ReferencedFolderName *string `mandatory:"false" json:"referencedFolderName"`
// Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
ReferencedEntityKey *string `mandatory:"false" json:"referencedEntityKey"`
// Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
ReferencedEntityName *string `mandatory:"false" json:"referencedEntityName"`
// Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
ReferencedRuleKey *string `mandatory:"false" json:"referencedRuleKey"`
// Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
ReferencedRuleName *string `mandatory:"false" json:"referencedRuleName"`
// Attributes associated with referenced rule, applicable only when rule type is FOREIGNKEY.
// A FOREIGNKEY rule would contain (at least) one attribute, for the local table column(s), and (at least) one referencedAttribute for referenced table column(s).
ReferencedAttributes []RuleAttribute `mandatory:"false" json:"referencedAttributes"`
// Origin type of the rule.
OriginType RuleOriginTypeEnum `mandatory:"false" json:"originType,omitempty"`
// URI to the rule instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The date and time the rule was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// State of the rule.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m RuleSummary) String() string
func (m RuleSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RuleTypeEnum Enum with underlying type: string
type RuleTypeEnum string
Set of constants representing the allowable values for RuleTypeEnum
const (
RuleTypePrimarykey RuleTypeEnum = "PRIMARYKEY"
RuleTypeForeignkey RuleTypeEnum = "FOREIGNKEY"
RuleTypeUniquekey RuleTypeEnum = "UNIQUEKEY"
)
func GetMappingRuleTypeEnum(val string) (RuleTypeEnum, bool)
GetMappingRuleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRuleTypeEnumValues() []RuleTypeEnum
GetRuleTypeEnumValues Enumerates the set of values for RuleTypeEnum
SearchCriteria Search Query object that allows complex search predicates that cannot be expressed through simple query params.
type SearchCriteria struct {
// Search query dsl that defines the query components including fields and predicates.
Query *string `mandatory:"false" json:"query"`
// Query string that a dataObject is to be searched with. Used in the faceted query request
FacetedQuery *string `mandatory:"false" json:"facetedQuery"`
// List of properties of dataObjects that needs to aggregated on for facets.
Dimensions []string `mandatory:"false" json:"dimensions"`
// Array of objects having details about sort field and order.
Sort []FacetedSearchSortRequest `mandatory:"false" json:"sort"`
Filters *FacetedSearchFilterRequest `mandatory:"false" json:"filters"`
}
func (m SearchCriteria) String() string
func (m SearchCriteria) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchCriteriaLifecycleStateEnum Enum with underlying type: string
type SearchCriteriaLifecycleStateEnum string
Set of constants representing the allowable values for SearchCriteriaLifecycleStateEnum
const (
SearchCriteriaLifecycleStateCreating SearchCriteriaLifecycleStateEnum = "CREATING"
SearchCriteriaLifecycleStateActive SearchCriteriaLifecycleStateEnum = "ACTIVE"
SearchCriteriaLifecycleStateInactive SearchCriteriaLifecycleStateEnum = "INACTIVE"
SearchCriteriaLifecycleStateUpdating SearchCriteriaLifecycleStateEnum = "UPDATING"
SearchCriteriaLifecycleStateDeleting SearchCriteriaLifecycleStateEnum = "DELETING"
SearchCriteriaLifecycleStateDeleted SearchCriteriaLifecycleStateEnum = "DELETED"
SearchCriteriaLifecycleStateFailed SearchCriteriaLifecycleStateEnum = "FAILED"
SearchCriteriaLifecycleStateMoving SearchCriteriaLifecycleStateEnum = "MOVING"
)
func GetMappingSearchCriteriaLifecycleStateEnum(val string) (SearchCriteriaLifecycleStateEnum, bool)
GetMappingSearchCriteriaLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSearchCriteriaLifecycleStateEnumValues() []SearchCriteriaLifecycleStateEnum
GetSearchCriteriaLifecycleStateEnumValues Enumerates the set of values for SearchCriteriaLifecycleStateEnum
SearchCriteriaRequest wrapper for the SearchCriteria operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/SearchCriteria.go.html to see an example of how to use SearchCriteriaRequest.
type SearchCriteriaRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The information used to create an extended search results.
SearchCriteriaDetails SearchCriteria `contributesTo:"body"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Immutable resource name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState SearchCriteriaLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the
// specified time value and bail with the hits accumulated up to that point when expired.
// Defaults to no timeout.
Timeout *string `mandatory:"false" contributesTo:"query" name:"timeout"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy SearchCriteriaSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder SearchCriteriaSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 SearchCriteriaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SearchCriteriaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SearchCriteriaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SearchCriteriaRequest) String() string
func (request SearchCriteriaRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchCriteriaResponse wrapper for the SearchCriteria operation
type SearchCriteriaResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SearchResultCollection instances
SearchResultCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response SearchCriteriaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SearchCriteriaResponse) String() string
SearchCriteriaSortByEnum Enum with underlying type: string
type SearchCriteriaSortByEnum string
Set of constants representing the allowable values for SearchCriteriaSortByEnum
const (
SearchCriteriaSortByTimecreated SearchCriteriaSortByEnum = "TIMECREATED"
SearchCriteriaSortByDisplayname SearchCriteriaSortByEnum = "DISPLAYNAME"
)
func GetMappingSearchCriteriaSortByEnum(val string) (SearchCriteriaSortByEnum, bool)
GetMappingSearchCriteriaSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSearchCriteriaSortByEnumValues() []SearchCriteriaSortByEnum
GetSearchCriteriaSortByEnumValues Enumerates the set of values for SearchCriteriaSortByEnum
SearchCriteriaSortOrderEnum Enum with underlying type: string
type SearchCriteriaSortOrderEnum string
Set of constants representing the allowable values for SearchCriteriaSortOrderEnum
const (
SearchCriteriaSortOrderAsc SearchCriteriaSortOrderEnum = "ASC"
SearchCriteriaSortOrderDesc SearchCriteriaSortOrderEnum = "DESC"
)
func GetMappingSearchCriteriaSortOrderEnum(val string) (SearchCriteriaSortOrderEnum, bool)
GetMappingSearchCriteriaSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSearchCriteriaSortOrderEnumValues() []SearchCriteriaSortOrderEnum
GetSearchCriteriaSortOrderEnumValues Enumerates the set of values for SearchCriteriaSortOrderEnum
SearchResult The search result object is the definition of an element that is returned as part of search. It contains basic information about the object such as key, name and description. The search result also contains the list of tags for each object along with other contextual information like the data asset root, folder, or entity parents.
type SearchResult struct {
// Unique key of the object returned as part of the search result.
Key *string `mandatory:"false" json:"key"`
// Name of the object.
Name *string `mandatory:"false" json:"name"`
// Detailed description of the object.
Description *string `mandatory:"false" json:"description"`
// The date and time the result object was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the result object was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Array of the tags associated with this object.
TagSummary []SearchTagSummary `mandatory:"false" json:"tagSummary"`
// Array of the terms associated with this object.
TermSummary []SearchTermSummary `mandatory:"false" json:"termSummary"`
// Name of the object type.
TypeName *string `mandatory:"false" json:"typeName"`
// Name of the external object type in the host data asset. For example, column, field, table, view, or file.
ExternalTypeName *string `mandatory:"false" json:"externalTypeName"`
// Data type of the object if the object is an attribute. Null otherwise.
ExternalDataType *string `mandatory:"false" json:"externalDataType"`
// Unique key of the data asset that is the root parent of this object.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Type name of the data asset. For example, Oracle, MySQL or Oracle Object Storage.
DataAssetType *string `mandatory:"false" json:"dataAssetType"`
// Name of the data asset that is the root parent of this object.
DataAssetName *string `mandatory:"false" json:"dataAssetName"`
// Unique key of the folder object if this object is a sub folder, entity, or attribute.
FolderKey *string `mandatory:"false" json:"folderKey"`
// Type name of the folder. For example, schema, directory, or topic.
FolderType *string `mandatory:"false" json:"folderType"`
// Name of the parent folder object if this object is a sub folder, entity, or attribute.
FolderName *string `mandatory:"false" json:"folderName"`
// Unique key of the entity object if this object is an attribute.
Entitykey *string `mandatory:"false" json:"entitykey"`
// Type name of the entity. For example, table, view, external table, file, or object.
EntityType *string `mandatory:"false" json:"entityType"`
// Name of the parent entity object if this object is an attribute.
EntityName *string `mandatory:"false" json:"entityName"`
// Unique id of the parent glossary.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Name of the parent glossary if this object is a term.
GlossaryName *string `mandatory:"false" json:"glossaryName"`
// This terms parent term key. Will be null if the term has no parent term.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// Name of the parent term. Will be null if the term has no parent term.
ParentTermName *string `mandatory:"false" json:"parentTermName"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Absolute path of this resource, which could be a term, folder, entity etc, usually resolvable to this resource through a namespace hierarchy.
Path *string `mandatory:"false" json:"path"`
// Optional user friendly business name of the data object. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// The current state of the data object.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Type name of the attribute. For example - complex, primitive, or array.
AttributeType *string `mandatory:"false" json:"attributeType"`
// Expression for logical entities against which names of dataObjects will be matched.
Expression *string `mandatory:"false" json:"expression"`
// Custom properties defined by users.
CustomProperties []FacetedSearchCustomProperty `mandatory:"false" json:"customProperties"`
// A map of maps that contains the properties which are specific to the element type in the search result.
// The map keys are category names and the values are maps of property name to property value. Every property
// is contained inside of a category. Most element types have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m SearchResult) String() string
func (m SearchResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchResultCollection The list of search result items matching the criteria returned from the search operation. Search errors and messages, if any , will be part of the standard error response.
type SearchResultCollection struct {
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
// Search result set.
Items []SearchResult `mandatory:"false" json:"items"`
// String that data objects are to be searched with.
Query *string `mandatory:"false" json:"query"`
// Aggregations/facets on properties of data objects.
FacetedSearchAggregation []FacetedSearchAggregation `mandatory:"false" json:"facetedSearchAggregation"`
// A list of fields or properties used in the sorting of a search result.
SortableFields []string `mandatory:"false" json:"sortableFields"`
}
func (m SearchResultCollection) String() string
func (m SearchResultCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchTagSummary Represents the association of an object to a term. Returned as part of search result.
type SearchTagSummary struct {
// Name of the tag that matches the term name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Unique tag key that is immutable.
Key *string `mandatory:"false" json:"key"`
}
func (m SearchTagSummary) String() string
func (m SearchTagSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchTermSummary Summary of a term associated with an object. This is a brief summary returned as part of the search result.
type SearchTermSummary struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Unique term key that is immutable.
Key *string `mandatory:"false" json:"key"`
// Unique id of the parent glossary.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Name of the parent glossary.
GlossaryName *string `mandatory:"false" json:"glossaryName"`
// This terms parent term key. Will be null if the term has no parent term.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// Name of the parent term key. Will be null if the term has no parent term.
ParentTermName *string `mandatory:"false" json:"parentTermName"`
}
func (m SearchTermSummary) String() string
func (m SearchTermSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SuggestListItem Details of a potential match returned from the suggest operation for the given input text. by the limit parameter.
type SuggestListItem struct {
// Potential string match. Matching is based on the frequency of usage within the catalog.
Suggestion *string `mandatory:"false" json:"suggestion"`
// The number of objects which contain this suggestion.
ObjectCount *int `mandatory:"false" json:"objectCount"`
}
func (m SuggestListItem) String() string
func (m SuggestListItem) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SuggestMatchesRequest wrapper for the SuggestMatches operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/SuggestMatches.go.html to see an example of how to use SuggestMatchesRequest.
type SuggestMatchesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Text input string used for computing potential matching suggestions.
InputText *string `mandatory:"true" contributesTo:"query" name:"inputText"`
// A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the
// specified time value and bail with the hits accumulated up to that point when expired.
// Defaults to no timeout.
Timeout *string `mandatory:"false" contributesTo:"query" name:"timeout"`
// Limit for the list of potential matches returned from the Suggest API. If not specified, will default to 10.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 SuggestMatchesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SuggestMatchesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SuggestMatchesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SuggestMatchesRequest) String() string
func (request SuggestMatchesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SuggestMatchesResponse wrapper for the SuggestMatches operation
type SuggestMatchesResponse struct {
// The underlying http response
RawResponse *http.Response
// The SuggestResults instance
SuggestResults `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"`
}
func (response SuggestMatchesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SuggestMatchesResponse) String() string
SuggestResults The list of potential matches returned from the suggest operation for the given input text. The size of the list will be determined by the limit parameter.
type SuggestResults struct {
// Total number of items returned.
TotalCount *int `mandatory:"true" json:"totalCount"`
// Input string for which the potential matches are computed.
InputText *string `mandatory:"true" json:"inputText"`
// Time taken to compute the result, in milliseconds.
SearchLatencyInMs *int `mandatory:"false" json:"searchLatencyInMs"`
// List of suggestions.
Items []SuggestListItem `mandatory:"false" json:"items"`
}
func (m SuggestResults) String() string
func (m SuggestResults) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SynchronousExportDataAssetRequest wrapper for the SynchronousExportDataAsset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/SynchronousExportDataAsset.go.html to see an example of how to use SynchronousExportDataAssetRequest.
type SynchronousExportDataAssetRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The details of what needs to be exported.
SynchronousExportDataAssetDetails ExportDataAssetDetails `contributesTo:"body"`
// Type of export.
ExportType []DataAssetImportExportTypeFilterEnum `contributesTo:"query" name:"exportType" omitEmpty:"true" collectionFormat:"multi"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 SynchronousExportDataAssetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SynchronousExportDataAssetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SynchronousExportDataAssetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SynchronousExportDataAssetRequest) String() string
func (request SynchronousExportDataAssetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SynchronousExportDataAssetResponse wrapper for the SynchronousExportDataAsset operation
type SynchronousExportDataAssetResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// 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"`
}
func (response SynchronousExportDataAssetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SynchronousExportDataAssetResponse) String() string
Term Full term definition. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level. Nesting of terms to support a hierarchy is supported by default.
type Term struct {
// Unique term key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the term.
Description *string `mandatory:"false" json:"description"`
// Unique id of the parent glossary.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// This terms parent term key. Will be null if the term has no parent term.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// Indicates whether a term may contain child terms.
IsAllowedToHaveChildTerms *bool `mandatory:"false" json:"isAllowedToHaveChildTerms"`
// Absolute path of the term.
Path *string `mandatory:"false" json:"path"`
// The current state of the term.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the term was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the term. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created the term.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who modified the term.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// OCID of the user who is the owner of this business terminology.
Owner *string `mandatory:"false" json:"owner"`
// Status of the approval process workflow for this business term in the glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// URI to the term instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// The number of objects tagged with this term
AssociatedObjectCount *int `mandatory:"false" json:"associatedObjectCount"`
// Array of objects associated to a term.
AssociatedObjects []TermAssociatedObject `mandatory:"false" json:"associatedObjects"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
}
func (m Term) String() string
func (m Term) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TermAssociatedObject Projection of an object that is tagged to a term.
type TermAssociatedObject struct {
// Immutable key used to uniquely identify the associated object.
Key *string `mandatory:"true" json:"key"`
// Name of the associated object.
Name *string `mandatory:"false" json:"name"`
// URI of the associated object within the data catalog API.
Uri *string `mandatory:"false" json:"uri"`
}
func (m TermAssociatedObject) String() string
func (m TermAssociatedObject) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TermCollection Results of a terms listing. Terms are defined in business glossary and are used in tagging catalog objects.
type TermCollection struct {
// Collection of terms.
Items []TermSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m TermCollection) String() string
func (m TermCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TermRelationship Full term relationship definition. Business term relationship between two terms in a business glossary.
type TermRelationship struct {
// Unique term relationship key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.This is the same as relationshipType for termRelationship
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the term relationship usually defined at the time of creation.
Description *string `mandatory:"false" json:"description"`
// Unique id of the related term.
RelatedTermKey *string `mandatory:"false" json:"relatedTermKey"`
// Name of the related term.
RelatedTermDisplayName *string `mandatory:"false" json:"relatedTermDisplayName"`
// Description of the related term.
RelatedTermDescription *string `mandatory:"false" json:"relatedTermDescription"`
// Full path of the related term.
RelatedTermPath *string `mandatory:"false" json:"relatedTermPath"`
// Glossary key of the related term.
RelatedTermGlossaryKey *string `mandatory:"false" json:"relatedTermGlossaryKey"`
// URI to the term relationship instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// This relationships parent term key.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// Name of the parent term.
ParentTermDisplayName *string `mandatory:"false" json:"parentTermDisplayName"`
// Description of the parent term.
ParentTermDescription *string `mandatory:"false" json:"parentTermDescription"`
// Full path of the parent term.
ParentTermPath *string `mandatory:"false" json:"parentTermPath"`
// Glossary key of the parent term.
ParentTermGlossaryKey *string `mandatory:"false" json:"parentTermGlossaryKey"`
// The date and time the term relationship was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// State of the term relationship.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m TermRelationship) String() string
func (m TermRelationship) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TermRelationshipCollection Results of a terms relationship listing. Term relationships are associations between two terms in business glossary.
type TermRelationshipCollection struct {
// Collection of term relationships.
Items []TermRelationshipSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m TermRelationshipCollection) String() string
func (m TermRelationshipCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TermRelationshipSummary Summary of a term relationship. Business term relationship between two terms in a business glossary.
type TermRelationshipSummary struct {
// Unique term relationship key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.This is the same as relationshipType for termRelationship
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the term relationship usually defined at the time of creation.
Description *string `mandatory:"false" json:"description"`
// Unique id of the related term.
RelatedTermKey *string `mandatory:"false" json:"relatedTermKey"`
// Name of the related term.
RelatedTermDisplayName *string `mandatory:"false" json:"relatedTermDisplayName"`
// Description of the related term.
RelatedTermDescription *string `mandatory:"false" json:"relatedTermDescription"`
// Full path of the related term.
RelatedTermPath *string `mandatory:"false" json:"relatedTermPath"`
// Glossary key of the related term.
RelatedTermGlossaryKey *string `mandatory:"false" json:"relatedTermGlossaryKey"`
// URI to the term relationship instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// This relationships parent term key.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// Name of the parent term.
ParentTermDisplayName *string `mandatory:"false" json:"parentTermDisplayName"`
// Description of the parent term.
ParentTermDescription *string `mandatory:"false" json:"parentTermDescription"`
// Full path of the parent term.
ParentTermPath *string `mandatory:"false" json:"parentTermPath"`
// Glossary key of the parent term.
ParentTermGlossaryKey *string `mandatory:"false" json:"parentTermGlossaryKey"`
// The date and time the term relationship was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// State of the term relationship.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m TermRelationshipSummary) String() string
func (m TermRelationshipSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TermSummary Summary of a term. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level.
type TermSummary struct {
// Unique term key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the term.
Description *string `mandatory:"false" json:"description"`
// Unique id of the parent glossary.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// URI to the term instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// This terms parent term key. Will be null if the term has no parent term.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// Indicates whether a term may contain child terms.
IsAllowedToHaveChildTerms *bool `mandatory:"false" json:"isAllowedToHaveChildTerms"`
// Absolute path of the term.
Path *string `mandatory:"false" json:"path"`
// The date and time the term was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Status of the approval process workflow for this business term in the glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// The number of objects tagged with this term.
AssociatedObjectCount *int `mandatory:"false" json:"associatedObjectCount"`
// State of the term.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m TermSummary) String() string
func (m TermSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TermWorkflowStatusEnum Enum with underlying type: string
type TermWorkflowStatusEnum string
Set of constants representing the allowable values for TermWorkflowStatusEnum
const (
TermWorkflowStatusNew TermWorkflowStatusEnum = "NEW"
TermWorkflowStatusApproved TermWorkflowStatusEnum = "APPROVED"
TermWorkflowStatusUnderReview TermWorkflowStatusEnum = "UNDER_REVIEW"
TermWorkflowStatusEscalated TermWorkflowStatusEnum = "ESCALATED"
)
func GetMappingTermWorkflowStatusEnum(val string) (TermWorkflowStatusEnum, bool)
GetMappingTermWorkflowStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTermWorkflowStatusEnumValues() []TermWorkflowStatusEnum
GetTermWorkflowStatusEnumValues Enumerates the set of values for TermWorkflowStatusEnum
TestConnectionRequest wrapper for the TestConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/TestConnection.go.html to see an example of how to use TestConnectionRequest.
type TestConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique connection key.
ConnectionKey *string `mandatory:"true" contributesTo:"path" name:"connectionKey"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 TestConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request TestConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request TestConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request TestConnectionRequest) String() string
func (request TestConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TestConnectionResponse wrapper for the TestConnection operation
type TestConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// The ValidateConnectionResult instance
ValidateConnectionResult `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response TestConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response TestConnectionResponse) String() string
TypeCollection Results of a types listing. Types define the basic type of catalog objects and are immutable.
type TypeCollection struct {
// Collection of types.
Items []TypeSummary `mandatory:"true" json:"items"`
// Total number of items returned.
Count *int `mandatory:"false" json:"count"`
}
func (m TypeCollection) String() string
func (m TypeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TypeCustomPropertyDetails Array of custom property IDs for which we have to associate the custom property to the type
type TypeCustomPropertyDetails struct {
// array of custom property Ids
CustomPropertyIds []string `mandatory:"false" json:"customPropertyIds"`
// If an OCI Event will be emitted when the custom property is modified.
IsEventEnabled *bool `mandatory:"false" json:"isEventEnabled"`
}
func (m TypeCustomPropertyDetails) String() string
func (m TypeCustomPropertyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TypeSummary Summary data catalog type information. All types are statically defined in the system and are immutable. It isn't possible to create new types or update existing types via the API.
type TypeSummary struct {
// Unique type key that is immutable.
Key *string `mandatory:"true" json:"key"`
// The immutable name of the type.
Name *string `mandatory:"false" json:"name"`
// Detailed description of the type.
Description *string `mandatory:"false" json:"description"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// Indicates the category this type belongs to. For instance, data assets, connections.
TypeCategory *string `mandatory:"false" json:"typeCategory"`
// URI to the type instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// State of the folder.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Unique key of the parent type.
ParentTypeKey *string `mandatory:"false" json:"parentTypeKey"`
// Name of the parent type.
ParentTypeName *string `mandatory:"false" json:"parentTypeName"`
}
func (m TypeSummary) String() string
func (m TypeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAttributeDetails Properties used in attribute update operations.
type UpdateAttributeDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of the attribute.
Description *string `mandatory:"false" json:"description"`
// Data type of the attribute as defined in the external system.
ExternalDataType *string `mandatory:"false" json:"externalDataType"`
// Property that identifies if this attribute can be used as a watermark to extract incremental data.
IsIncrementalData *bool `mandatory:"false" json:"isIncrementalData"`
// Property that identifies if this attribute can be assigned nullable values.
IsNullable *bool `mandatory:"false" json:"isNullable"`
// Max allowed length of the attribute value.
Length *int64 `mandatory:"false" json:"length"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" json:"position"`
// Precision of the attribute value usually applies to float data type.
Precision *int `mandatory:"false" json:"precision"`
// Scale of the attribute value usually applies to float data type.
Scale *int `mandatory:"false" json:"scale"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
MinCollectionCount *int `mandatory:"false" json:"minCollectionCount"`
// The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
// For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".
// Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json
MaxCollectionCount *int `mandatory:"false" json:"maxCollectionCount"`
// External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
ExternalDatatypeEntityKey *string `mandatory:"false" json:"externalDatatypeEntityKey"`
// External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
ExternalParentAttributeKey *string `mandatory:"false" json:"externalParentAttributeKey"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the attribute type. Each attribute type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// attributes have required properties within the "default" category. To determine the set of required and
// optional properties for an Attribute type, a query can be done on '/types?type=attribute' which returns a
// collection of all attribute types. The appropriate attribute type, which will include definitions of all
// of it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m UpdateAttributeDetails) String() string
func (m UpdateAttributeDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAttributeRequest wrapper for the UpdateAttribute operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateAttribute.go.html to see an example of how to use UpdateAttributeRequest.
type UpdateAttributeRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// Unique attribute key.
AttributeKey *string `mandatory:"true" contributesTo:"path" name:"attributeKey"`
// The information to be updated in the attribute.
UpdateAttributeDetails `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 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"`
// 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 UpdateAttributeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAttributeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAttributeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAttributeRequest) String() string
func (request UpdateAttributeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateAttributeResponse wrapper for the UpdateAttribute operation
type UpdateAttributeResponse struct {
// The underlying http response
RawResponse *http.Response
// The Attribute instance
Attribute `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateAttributeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAttributeResponse) String() string
UpdateCatalogDetails The information to be updated for catalog resource.
type UpdateCatalogDetails struct {
// Data catalog identifier.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateCatalogDetails) String() string
func (m UpdateCatalogDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCatalogPrivateEndpointDetails Information about the modified private endpoint resource
type UpdateCatalogPrivateEndpointDetails struct {
// List of DNS zones to be used by the data assets to be harvested.
// Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
DnsZones []string `mandatory:"false" json:"dnsZones"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Display name of the private endpoint resource.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m UpdateCatalogPrivateEndpointDetails) String() string
func (m UpdateCatalogPrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCatalogPrivateEndpointRequest wrapper for the UpdateCatalogPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateCatalogPrivateEndpoint.go.html to see an example of how to use UpdateCatalogPrivateEndpointRequest.
type UpdateCatalogPrivateEndpointRequest struct {
// Unique private reverse connection identifier.
CatalogPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"catalogPrivateEndpointId"`
// The information to be updated in private reverse connection
UpdateCatalogPrivateEndpointDetails `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 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"`
// 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 UpdateCatalogPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCatalogPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCatalogPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCatalogPrivateEndpointRequest) String() string
func (request UpdateCatalogPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCatalogPrivateEndpointResponse wrapper for the UpdateCatalogPrivateEndpoint operation
type UpdateCatalogPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID of the asynchronous request. Use GetWorkRequest (https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateCatalogPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCatalogPrivateEndpointResponse) String() string
UpdateCatalogRequest wrapper for the UpdateCatalog operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateCatalog.go.html to see an example of how to use UpdateCatalogRequest.
type UpdateCatalogRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The data catalog information to be updated.
UpdateCatalogDetails `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 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"`
// 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 UpdateCatalogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCatalogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCatalogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCatalogRequest) String() string
func (request UpdateCatalogRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCatalogResponse wrapper for the UpdateCatalog operation
type UpdateCatalogResponse struct {
// The underlying http response
RawResponse *http.Response
// The Catalog instance
Catalog `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateCatalogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCatalogResponse) String() string
UpdateConnectionDetails Properties used in connection update operations.
type UpdateConnectionDetails struct {
// A description of the connection.
Description *string `mandatory:"false" json:"description"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the connection type. Each connection type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// connections have required properties within the "default" category. To determine the set of optional and
// required properties for a connection type, a query can be done on '/types?type=connection' that returns a
// collection of all connection types. The appropriate connection type, which will include definitions of all
// of it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "username": "user1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
// A map of maps that contains the encrypted values for sensitive properties which are specific to the
// connection type. Each connection type definition defines it's set of required and optional properties.
// The map keys are category names and the values are maps of property name to property value. Every property is
// contained inside of a category. Most connections have required properties within the "default" category.
// To determine the set of optional and required properties for a connection type, a query can be done
// on '/types?type=connection' that returns a collection of all connection types. The appropriate connection
// type, which will include definitions of all of it's properties, can be identified from this collection.
// Example: `{"encProperties": { "default": { "password": "example-password"}}}`
EncProperties map[string]map[string]string `mandatory:"false" json:"encProperties"`
// Indicates whether this connection is the default connection.
IsDefault *bool `mandatory:"false" json:"isDefault"`
}
func (m UpdateConnectionDetails) String() string
func (m UpdateConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateConnectionRequest wrapper for the UpdateConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateConnection.go.html to see an example of how to use UpdateConnectionRequest.
type UpdateConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique connection key.
ConnectionKey *string `mandatory:"true" contributesTo:"path" name:"connectionKey"`
// The information to be updated in the connection.
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 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"`
// 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 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
// The Connection instance
Connection `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateConnectionResponse) String() string
UpdateCustomPropertyDetails Properties used in custom atrribute update operations.
type UpdateCustomPropertyDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the data asset.
Description *string `mandatory:"false" json:"description"`
// If this field allows to sort from UI
IsSortable *bool `mandatory:"false" json:"isSortable"`
// If this field allows to filter or create facets from UI
IsFilterable *bool `mandatory:"false" json:"isFilterable"`
// If this field allows multiple values to be set
IsMultiValued *bool `mandatory:"false" json:"isMultiValued"`
// If this field is a hidden field
IsHidden *bool `mandatory:"false" json:"isHidden"`
// If this field is a editable field
IsEditable *bool `mandatory:"false" json:"isEditable"`
// If this field is displayed in a list view of applicable objects.
IsShownInList *bool `mandatory:"false" json:"isShownInList"`
// If this field is allowed to pop in search results
IsHiddenInSearch *bool `mandatory:"false" json:"isHiddenInSearch"`
// If an OCI Event will be emitted when the custom property is modified.
IsEventEnabled *bool `mandatory:"false" json:"isEventEnabled"`
// Allowed values for the custom property if any
AllowedValues []string `mandatory:"false" json:"allowedValues"`
// A map of maps that contains the properties which are specific to the asset type. Each data asset type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data assets have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m UpdateCustomPropertyDetails) String() string
func (m UpdateCustomPropertyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCustomPropertyRequest wrapper for the UpdateCustomProperty operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateCustomProperty.go.html to see an example of how to use UpdateCustomPropertyRequest.
type UpdateCustomPropertyRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// Unique Custom Property key
CustomPropertyKey *string `mandatory:"true" contributesTo:"path" name:"customPropertyKey"`
// The information to be updated in the custom property.
UpdateCustomPropertyDetails `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 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"`
// 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 UpdateCustomPropertyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCustomPropertyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCustomPropertyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCustomPropertyRequest) String() string
func (request UpdateCustomPropertyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCustomPropertyResponse wrapper for the UpdateCustomProperty operation
type UpdateCustomPropertyResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomProperty instance
CustomProperty `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateCustomPropertyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCustomPropertyResponse) String() string
UpdateDataAssetDetails Properties used in data asset update operations.
type UpdateDataAssetDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the data asset.
Description *string `mandatory:"false" json:"description"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the asset type. Each data asset type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// data assets have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m UpdateDataAssetDetails) String() string
func (m UpdateDataAssetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDataAssetRequest wrapper for the UpdateDataAsset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateDataAsset.go.html to see an example of how to use UpdateDataAssetRequest.
type UpdateDataAssetRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information to be updated in the data asset.
UpdateDataAssetDetails `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 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"`
// 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 UpdateDataAssetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDataAssetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDataAssetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDataAssetRequest) String() string
func (request UpdateDataAssetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDataAssetResponse wrapper for the UpdateDataAsset operation
type UpdateDataAssetResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataAsset instance
DataAsset `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateDataAssetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDataAssetResponse) String() string
UpdateEntityDetails Properties used in entity update operations.
type UpdateEntityDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of a data entity.
Description *string `mandatory:"false" json:"description"`
// Last modified timestamp of the object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// Property to indicate if the object is a physical materialized object or virtual. For example, View.
IsLogical *bool `mandatory:"false" json:"isLogical"`
// Property to indicate if the object is a sub object of a parent physical object.
IsPartition *bool `mandatory:"false" json:"isPartition"`
// Key of the associated folder.
FolderKey *string `mandatory:"false" json:"folderKey"`
// Key of the associated pattern if this is a logical entity.
PatternKey *string `mandatory:"false" json:"patternKey"`
// The expression realized after resolving qualifiers . Used in deriving this logical entity
RealizedExpression *string `mandatory:"false" json:"realizedExpression"`
// Status of the object as updated by the harvest process. When an entity object is created, it's harvest status
// will indicate if the entity's metadata has been fully harvested or not. The harvest process can perform
// shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object
// This requires a harvest status indicator for catalog objects.
HarvestStatus HarvestStatusEnum `mandatory:"false" json:"harvestStatus,omitempty"`
// Key of the last harvest process to update this object.
LastJobKey *string `mandatory:"false" json:"lastJobKey"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the entity type. Each entity type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// entities have required properties within the "default" category. To determine the set of required and
// optional properties for an entity type, a query can be done on '/types?type=dataEntity' that returns a
// collection of all entity types. The appropriate entity type, which includes definitions of all of
// it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m UpdateEntityDetails) String() string
func (m UpdateEntityDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateEntityRequest wrapper for the UpdateEntity operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateEntity.go.html to see an example of how to use UpdateEntityRequest.
type UpdateEntityRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// The information to be updated in the data entity.
UpdateEntityDetails `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 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"`
// 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 UpdateEntityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateEntityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateEntityRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateEntityRequest) String() string
func (request UpdateEntityRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateEntityResponse wrapper for the UpdateEntity operation
type UpdateEntityResponse struct {
// The underlying http response
RawResponse *http.Response
// The Entity instance
Entity `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateEntityResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateEntityResponse) String() string
UpdateFolderDetails Properties used in folder update operations.
type UpdateFolderDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of a folder.
Description *string `mandatory:"false" json:"description"`
// The key of the containing folder.
ParentFolderKey *string `mandatory:"false" json:"parentFolderKey"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the folder type. Each folder type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// folders have required properties within the "default" category. To determine the set of optional and
// required properties for a folder type, a query can be done on '/types?type=folder' that returns a
// collection of all folder types. The appropriate folder type, which includes definitions of all of
// it's properties, can be identified from this collection.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// Harvest status of the folder.
HarvestStatus HarvestStatusEnum `mandatory:"false" json:"harvestStatus,omitempty"`
// The key of the last harvest process to update the metadata of this object.
LastJobKey *string `mandatory:"false" json:"lastJobKey"`
}
func (m UpdateFolderDetails) String() string
func (m UpdateFolderDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateFolderRequest wrapper for the UpdateFolder operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateFolder.go.html to see an example of how to use UpdateFolderRequest.
type UpdateFolderRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique folder key.
FolderKey *string `mandatory:"true" contributesTo:"path" name:"folderKey"`
// The information to be updated in the folder.
UpdateFolderDetails `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 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"`
// 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 UpdateFolderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateFolderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateFolderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateFolderRequest) String() string
func (request UpdateFolderRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateFolderResponse wrapper for the UpdateFolder operation
type UpdateFolderResponse struct {
// The underlying http response
RawResponse *http.Response
// The Folder instance
Folder `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateFolderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateFolderResponse) String() string
UpdateGlossaryDetails Properties used in glossary update operations.
type UpdateGlossaryDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the glossary.
Description *string `mandatory:"false" json:"description"`
// OCID of the user who is the owner of the glossary.
Owner *string `mandatory:"false" json:"owner"`
// Status of the approval process workflow for this business glossary.
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
}
func (m UpdateGlossaryDetails) String() string
func (m UpdateGlossaryDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGlossaryRequest wrapper for the UpdateGlossary operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateGlossary.go.html to see an example of how to use UpdateGlossaryRequest.
type UpdateGlossaryRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// The information to be updated in the glossary.
UpdateGlossaryDetails `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 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"`
// 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 UpdateGlossaryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGlossaryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGlossaryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGlossaryRequest) String() string
func (request UpdateGlossaryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGlossaryResponse wrapper for the UpdateGlossary operation
type UpdateGlossaryResponse struct {
// The underlying http response
RawResponse *http.Response
// The Glossary instance
Glossary `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateGlossaryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGlossaryResponse) String() string
UpdateJobDefinitionDetails Update information for a job definition resource.
type UpdateJobDefinitionDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Specifies if the job definition is incremental or full.
IsIncremental *bool `mandatory:"false" json:"isIncremental"`
// The key of the data asset for which the job is defined.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Detailed description of the job definition.
Description *string `mandatory:"false" json:"description"`
// The key of the connection resource to be used for harvest, sampling, profiling jobs.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
// Specify if sample data to be extracted as part of this harvest.
IsSampleDataExtracted *bool `mandatory:"false" json:"isSampleDataExtracted"`
// Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
SampleDataSizeInMBs *int `mandatory:"false" json:"sampleDataSizeInMBs"`
// A map of maps that contains the properties which are specific to the job type. Each job type
// definition may define it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// job definitions have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m UpdateJobDefinitionDetails) String() string
func (m UpdateJobDefinitionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateJobDefinitionRequest wrapper for the UpdateJobDefinition operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateJobDefinition.go.html to see an example of how to use UpdateJobDefinitionRequest.
type UpdateJobDefinitionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job definition key.
JobDefinitionKey *string `mandatory:"true" contributesTo:"path" name:"jobDefinitionKey"`
// The information to be updated in the job definition.
UpdateJobDefinitionDetails `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 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"`
// 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 UpdateJobDefinitionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateJobDefinitionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateJobDefinitionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateJobDefinitionRequest) String() string
func (request UpdateJobDefinitionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateJobDefinitionResponse wrapper for the UpdateJobDefinition operation
type UpdateJobDefinitionResponse struct {
// The underlying http response
RawResponse *http.Response
// The JobDefinition instance
JobDefinition `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateJobDefinitionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateJobDefinitionResponse) String() string
UpdateJobDetails Job properties that can be updated.
type UpdateJobDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the job.
Description *string `mandatory:"false" json:"description"`
// Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".
// The following subset of those is supported: @monthly, @weekly, @daily, @hourly.
// For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.
ScheduleCronExpression *string `mandatory:"false" json:"scheduleCronExpression"`
// Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleBegin *common.SDKTime `mandatory:"false" json:"timeScheduleBegin"`
// Date that the schedule should end from being operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleEnd *common.SDKTime `mandatory:"false" json:"timeScheduleEnd"`
// The key of the connection resource that is used for the harvest by this job.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
}
func (m UpdateJobDetails) String() string
func (m UpdateJobDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateJobRequest wrapper for the UpdateJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateJob.go.html to see an example of how to use UpdateJobRequest.
type UpdateJobRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique job key.
JobKey *string `mandatory:"true" contributesTo:"path" name:"jobKey"`
// The information to be updated in the job.
UpdateJobDetails `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 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"`
// 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 UpdateJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateJobRequest) String() string
func (request UpdateJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateJobResponse wrapper for the UpdateJob operation
type UpdateJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The Job instance
Job `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateJobResponse) String() string
UpdateMetastoreDetails Information to be updated for an existing metastore.
type UpdateMetastoreDetails struct {
// Mutable name of the metastore.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateMetastoreDetails) String() string
func (m UpdateMetastoreDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMetastoreRequest wrapper for the UpdateMetastore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateMetastore.go.html to see an example of how to use UpdateMetastoreRequest.
type UpdateMetastoreRequest struct {
// The metastore's OCID.
MetastoreId *string `mandatory:"true" contributesTo:"path" name:"metastoreId"`
// The metastore information to be updated.
UpdateMetastoreDetails `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 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"`
// 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 UpdateMetastoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateMetastoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateMetastoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateMetastoreRequest) String() string
func (request UpdateMetastoreRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateMetastoreResponse wrapper for the UpdateMetastore operation
type UpdateMetastoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The Metastore instance
Metastore `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateMetastoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateMetastoreResponse) String() string
UpdateNamespaceDetails Properties used in namespace update operations.
type UpdateNamespaceDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the namespace.
Description *string `mandatory:"false" json:"description"`
// If this field is defined by service or by a user
IsServiceDefined *bool `mandatory:"false" json:"isServiceDefined"`
}
func (m UpdateNamespaceDetails) String() string
func (m UpdateNamespaceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateNamespaceRequest wrapper for the UpdateNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateNamespace.go.html to see an example of how to use UpdateNamespaceRequest.
type UpdateNamespaceRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique namespace identifier.
NamespaceId *string `mandatory:"true" contributesTo:"path" name:"namespaceId"`
// The information to be updated in the namespace.
UpdateNamespaceDetails `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 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"`
// 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 UpdateNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNamespaceRequest) String() string
func (request UpdateNamespaceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateNamespaceResponse wrapper for the UpdateNamespace operation
type UpdateNamespaceResponse struct {
// The underlying http response
RawResponse *http.Response
// The Namespace instance
Namespace `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNamespaceResponse) String() string
UpdatePatternDetails Properties used in pattern update operations.
type UpdatePatternDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the Pattern.
Description *string `mandatory:"false" json:"description"`
// Input string which drives the selection process, allowing for fine-grained control using qualifiers.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
Expression *string `mandatory:"false" json:"expression"`
// Input string which drives the selection process.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
FilePathPrefix *string `mandatory:"false" json:"filePathPrefix"`
// List of file paths against which the pattern can be tried, as a check. This documents, for reference
// purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true,
// this will be run as a validation during the request, such that if the check fails the request fails. If
// isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even
// if the check fails, with a lifecycleState of FAILED.
CheckFilePathList []string `mandatory:"false" json:"checkFilePathList"`
// Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of
// UNMATCHED files is above the checkFailureLimit.
IsEnableCheckFailureLimit *bool `mandatory:"false" json:"isEnableCheckFailureLimit"`
// The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if
// checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.
CheckFailureLimit *int `mandatory:"false" json:"checkFailureLimit"`
// A map of maps that contains the properties which are specific to the pattern type. Each pattern type
// definition defines it's set of required and optional properties.
// Example: `{"properties": { "default": { "tbd"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m UpdatePatternDetails) String() string
func (m UpdatePatternDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePatternRequest wrapper for the UpdatePattern operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdatePattern.go.html to see an example of how to use UpdatePatternRequest.
type UpdatePatternRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique pattern key.
PatternKey *string `mandatory:"true" contributesTo:"path" name:"patternKey"`
// The information to be updated in the pattern.
UpdatePatternDetails `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 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"`
// 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 UpdatePatternRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePatternRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePatternRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePatternRequest) String() string
func (request UpdatePatternRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePatternResponse wrapper for the UpdatePattern operation
type UpdatePatternResponse struct {
// The underlying http response
RawResponse *http.Response
// The Pattern instance
Pattern `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdatePatternResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePatternResponse) String() string
UpdateTermDetails Properties used in term update operations.
type UpdateTermDetails struct {
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the term.
Description *string `mandatory:"false" json:"description"`
// The parent key of the term. In the case of a root-level category only, the term would have no parent and this should be left unset.
ParentTermKey *string `mandatory:"false" json:"parentTermKey"`
// OCID of the user who is the owner of this business terminology.
Owner *string `mandatory:"false" json:"owner"`
// Status of the approval process workflow for this business term in the glossary
WorkflowStatus TermWorkflowStatusEnum `mandatory:"false" json:"workflowStatus,omitempty"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertySetUsage `mandatory:"false" json:"customPropertyMembers"`
}
func (m UpdateTermDetails) String() string
func (m UpdateTermDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateTermRelationshipDetails Properties used in term relationship update operations.
type UpdateTermRelationshipDetails struct {
// A user-friendly display name. Is changeable. The combination of 'displayName' and 'parentTermKey'
// must be unique. Avoid entering confidential information. This is the same as 'relationshipType' for 'termRelationship'.
DisplayName *string `mandatory:"false" json:"displayName"`
// Detailed description of the term relationship usually defined at the time of creation.
Description *string `mandatory:"false" json:"description"`
}
func (m UpdateTermRelationshipDetails) String() string
func (m UpdateTermRelationshipDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateTermRelationshipRequest wrapper for the UpdateTermRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateTermRelationship.go.html to see an example of how to use UpdateTermRelationshipRequest.
type UpdateTermRelationshipRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// Unique glossary term relationship key.
TermRelationshipKey *string `mandatory:"true" contributesTo:"path" name:"termRelationshipKey"`
// The information to be updated in the term relationship.
UpdateTermRelationshipDetails `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 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"`
// 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 UpdateTermRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTermRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTermRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTermRelationshipRequest) String() string
func (request UpdateTermRelationshipRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateTermRelationshipResponse wrapper for the UpdateTermRelationship operation
type UpdateTermRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// The TermRelationship instance
TermRelationship `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateTermRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTermRelationshipResponse) String() string
UpdateTermRequest wrapper for the UpdateTerm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UpdateTerm.go.html to see an example of how to use UpdateTermRequest.
type UpdateTermRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// Unique glossary term key.
TermKey *string `mandatory:"true" contributesTo:"path" name:"termKey"`
// The information to be updated in the term.
UpdateTermDetails `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 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"`
// 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 UpdateTermRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTermRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTermRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTermRequest) String() string
func (request UpdateTermRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateTermResponse wrapper for the UpdateTerm operation
type UpdateTermResponse struct {
// The underlying http response
RawResponse *http.Response
// The Term instance
Term `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UpdateTermResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTermResponse) String() string
UploadCredentialsDetails Upload credential file and connection metadata.
type UploadCredentialsDetails struct {
// Information used in updating connection credentials.
CredentialPayload []byte `mandatory:"true" json:"credentialPayload"`
ConnectionDetail *UpdateConnectionDetails `mandatory:"false" json:"connectionDetail"`
}
func (m UploadCredentialsDetails) String() string
func (m UploadCredentialsDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UploadCredentialsRequest wrapper for the UploadCredentials operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/UploadCredentials.go.html to see an example of how to use UploadCredentialsRequest.
type UploadCredentialsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique connection key.
ConnectionKey *string `mandatory:"true" contributesTo:"path" name:"connectionKey"`
// The information used to upload the credentials file and metadata for updating this connection.
UploadCredentialsDetails `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 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 UploadCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UploadCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UploadCredentialsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UploadCredentialsRequest) String() string
func (request UploadCredentialsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UploadCredentialsResponse wrapper for the UploadCredentials operation
type UploadCredentialsResponse struct {
// The underlying http response
RawResponse *http.Response
// The Connection instance
Connection `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response UploadCredentialsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UploadCredentialsResponse) String() string
UsersRequest wrapper for the Users operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/Users.go.html to see an example of how to use UsersRequest.
type UsersRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
SortBy UsersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder UsersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 UsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UsersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UsersRequest) String() string
func (request UsersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UsersResponse wrapper for the Users operation
type UsersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of string instances
Value *string `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response UsersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UsersResponse) String() string
UsersSortByEnum Enum with underlying type: string
type UsersSortByEnum string
Set of constants representing the allowable values for UsersSortByEnum
const (
UsersSortByTimecreated UsersSortByEnum = "TIMECREATED"
UsersSortByDisplayname UsersSortByEnum = "DISPLAYNAME"
)
func GetMappingUsersSortByEnum(val string) (UsersSortByEnum, bool)
GetMappingUsersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsersSortByEnumValues() []UsersSortByEnum
GetUsersSortByEnumValues Enumerates the set of values for UsersSortByEnum
UsersSortOrderEnum Enum with underlying type: string
type UsersSortOrderEnum string
Set of constants representing the allowable values for UsersSortOrderEnum
const (
UsersSortOrderAsc UsersSortOrderEnum = "ASC"
UsersSortOrderDesc UsersSortOrderEnum = "DESC"
)
func GetMappingUsersSortOrderEnum(val string) (UsersSortOrderEnum, bool)
GetMappingUsersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsersSortOrderEnumValues() []UsersSortOrderEnum
GetUsersSortOrderEnumValues Enumerates the set of values for UsersSortOrderEnum
ValidateConnectionDetails Validate connection from the connection metadata or oracle wallet file.
type ValidateConnectionDetails struct {
ConnectionDetail *CreateConnectionDetails `mandatory:"false" json:"connectionDetail"`
// The information used to validate the connection.
ConnectionPayload []byte `mandatory:"false" json:"connectionPayload"`
}
func (m ValidateConnectionDetails) String() string
func (m ValidateConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ValidateConnectionRequest wrapper for the ValidateConnection operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ValidateConnection.go.html to see an example of how to use ValidateConnectionRequest.
type ValidateConnectionRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// The information used to validate the connections.
ValidateConnectionDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ValidateConnectionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ValidateConnectionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ValidateConnectionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ValidateConnectionRequest) String() string
func (request ValidateConnectionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ValidateConnectionResponse wrapper for the ValidateConnection operation
type ValidateConnectionResponse struct {
// The underlying http response
RawResponse *http.Response
// The ValidateConnectionResult instance
ValidateConnectionResult `presentIn:"body"`
// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response ValidateConnectionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ValidateConnectionResponse) String() string
ValidateConnectionResult Details regarding the validation of a connection resource.
type ValidateConnectionResult struct {
// The status returned from the connection validation.
Status ConnectionResultEnum `mandatory:"true" json:"status"`
// The message from the connection validation.
Message *string `mandatory:"false" json:"message"`
}
func (m ValidateConnectionResult) String() string
func (m ValidateConnectionResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ValidatePatternDetails Validate pattern using the expression and file list.
type ValidatePatternDetails struct {
// Input string which drives the selection process, allowing for fine-grained control using qualifiers.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
Expression *string `mandatory:"false" json:"expression"`
// Input string which drives the selection process.
// Refer to the user documentation for details of the format and examples. A pattern cannot include both
// a prefix and an expression.
FilePathPrefix *string `mandatory:"false" json:"filePathPrefix"`
// List of file paths against which the pattern can be tried, as a check. This documents, for reference
// purposes, some example objects a pattern is meant to work with.
// If provided with the request,this overrides the list which already exists as part of the pattern, if any.
CheckFilePathList []string `mandatory:"false" json:"checkFilePathList"`
// The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails.
// Optional, if checkFilePathList is provided.
// If provided with the request, this overrides the value which already exists as part of the pattern, if any.
CheckFailureLimit *int `mandatory:"false" json:"checkFailureLimit"`
}
func (m ValidatePatternDetails) String() string
func (m ValidatePatternDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ValidatePatternRequest wrapper for the ValidatePattern operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ValidatePattern.go.html to see an example of how to use ValidatePatternRequest.
type ValidatePatternRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique pattern key.
PatternKey *string `mandatory:"true" contributesTo:"path" name:"patternKey"`
// The information used to validate the pattern.
ValidatePatternDetails `contributesTo:"body"`
// 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 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
// has been deleted and purged from the system, then a retry of the original creation request
// might be 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 ValidatePatternRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ValidatePatternRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ValidatePatternRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ValidatePatternRequest) String() string
func (request ValidatePatternRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ValidatePatternResponse wrapper for the ValidatePattern operation
type ValidatePatternResponse struct {
// The underlying http response
RawResponse *http.Response
// The ValidatePatternResult instance
ValidatePatternResult `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"`
}
func (response ValidatePatternResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ValidatePatternResponse) String() string
ValidatePatternResult Details regarding the validation of a pattern resource.
type ValidatePatternResult struct {
// The status returned from the pattern validation.
Status *string `mandatory:"true" json:"status"`
// The message from the pattern validation.
Message *string `mandatory:"false" json:"message"`
// The expression used in the pattern validation.
Expression *string `mandatory:"false" json:"expression"`
// The prefix used in the pattern validation.
FilePathPrefix *string `mandatory:"false" json:"filePathPrefix"`
// Collection of logical entities derived from the pattern, as applied to a list of file paths.
DerivedLogicalEntities []DerivedLogicalEntities `mandatory:"false" json:"derivedLogicalEntities"`
}
func (m ValidatePatternResult) String() string
func (m ValidatePatternResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequest A description of workrequest status.
type WorkRequest struct {
// Type of the work request.
OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status WorkRequestStatusEnum `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, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
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. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
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
WorkRequestLog A log message from the execution of a work request.
type WorkRequestLog struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLog) String() string
func (m WorkRequestLog) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeCreateCatalog WorkRequestOperationTypeEnum = "CREATE_CATALOG"
WorkRequestOperationTypeUpdateCatalog WorkRequestOperationTypeEnum = "UPDATE_CATALOG"
WorkRequestOperationTypeDeleteCatalog WorkRequestOperationTypeEnum = "DELETE_CATALOG"
WorkRequestOperationTypeMoveCatalog WorkRequestOperationTypeEnum = "MOVE_CATALOG"
WorkRequestOperationTypeCreateCatalogPrivateEndpoint WorkRequestOperationTypeEnum = "CREATE_CATALOG_PRIVATE_ENDPOINT"
WorkRequestOperationTypeDeleteCatalogPrivateEndpoint WorkRequestOperationTypeEnum = "DELETE_CATALOG_PRIVATE_ENDPOINT"
WorkRequestOperationTypeUpdateCatalogPrivateEndpoint WorkRequestOperationTypeEnum = "UPDATE_CATALOG_PRIVATE_ENDPOINT"
WorkRequestOperationTypeMoveCatalogPrivateEndpoint WorkRequestOperationTypeEnum = "MOVE_CATALOG_PRIVATE_ENDPOINT"
WorkRequestOperationTypeAttachCatalogPrivateEndpoint WorkRequestOperationTypeEnum = "ATTACH_CATALOG_PRIVATE_ENDPOINT"
WorkRequestOperationTypeDetachCatalogPrivateEndpoint WorkRequestOperationTypeEnum = "DETACH_CATALOG_PRIVATE_ENDPOINT"
WorkRequestOperationTypeCreateMetastore WorkRequestOperationTypeEnum = "CREATE_METASTORE"
WorkRequestOperationTypeUpdateMetastore WorkRequestOperationTypeEnum = "UPDATE_METASTORE"
WorkRequestOperationTypeDeleteMetastore WorkRequestOperationTypeEnum = "DELETE_METASTORE"
WorkRequestOperationTypeMoveMetastore WorkRequestOperationTypeEnum = "MOVE_METASTORE"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
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.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET 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
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeMoved WorkRequestResourceActionTypeEnum = "MOVED"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum